Skip to content

:doc-ument the operators #16010

@roberth

Description

@roberth

Is your feature request related to a problem?

nix-repl> :doc >
error: syntax error, unexpected '>'
       at «string»:1:1:
            1| >
             |

So I ask, why not?

Proposed solution

Special-case the operators.
Add operator docs into libexpr and make nix spit them out for the manual's generated markdown.

Alternative solutions

  • Generalize :doc to a complete documentation reader. Could be nice. Too much scope creep. Awkward to combine titles or title-identifiers and code in one place, but maybe that's just me.

Additional context

Checklist


Add 👍 to issues you find important.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationfeatureFeature request or proposalreplThe Read Eval Print Loop, "nix repl" command and debugger
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions