2024-07-09 17:25:45 +00:00
|
|
|
Nix <nix version>
|
|
|
|
Type :? for help.
|
2024-07-23 15:52:28 +00:00
|
|
|
|
|
|
|
nix-repl> :l doc-comments.nix
|
2024-07-09 17:25:45 +00:00
|
|
|
Added <number omitted> variables.
|
|
|
|
|
2024-07-23 15:52:28 +00:00
|
|
|
nix-repl> :doc constant
|
2024-07-09 17:25:45 +00:00
|
|
|
error: value does not have documentation
|
|
|
|
|
2024-07-23 15:52:28 +00:00
|
|
|
nix-repl> :doc lib.version
|
|
|
|
Attribute `version`
|
2024-07-09 17:25:45 +00:00
|
|
|
|
2024-07-23 15:52:28 +00:00
|
|
|
… defined at /path/to/tests/functional/repl/doc-comments.nix:30:3
|
2024-07-09 17:25:45 +00:00
|
|
|
|
2024-07-23 15:52:28 +00:00
|
|
|
Immovably fixed.
|
2024-07-09 17:25:45 +00:00
|
|
|
|
2024-07-23 15:52:28 +00:00
|
|
|
nix-repl> :doc lib.attr.empty
|
|
|
|
Attribute `empty`
|
2024-07-09 17:25:45 +00:00
|
|
|
|
2024-07-23 15:52:28 +00:00
|
|
|
… defined at /path/to/tests/functional/repl/doc-comments.nix:33:3
|
2024-07-09 17:25:45 +00:00
|
|
|
|
2024-07-23 15:52:28 +00:00
|
|
|
Unchangeably constant.
|
2024-07-09 17:25:45 +00:00
|
|
|
|
2024-07-23 15:52:28 +00:00
|
|
|
nix-repl> :doc lib.attr.undocument
|
2024-07-09 17:25:45 +00:00
|
|
|
error:
|
|
|
|
… while evaluating the attribute 'attr.undocument'
|
2024-07-15 12:27:09 +00:00
|
|
|
at /path/to/tests/functional/repl/doc-comments.nix:33:3:
|
|
|
|
32| /** Unchangeably constant. */
|
|
|
|
33| lib.attr.empty = { };
|
2024-07-09 17:25:45 +00:00
|
|
|
| ^
|
2024-07-15 12:27:09 +00:00
|
|
|
34|
|
2024-07-09 17:25:45 +00:00
|
|
|
|
|
|
|
error: attribute 'undocument' missing
|
|
|
|
at «string»:1:1:
|
|
|
|
1| lib.attr.undocument
|
|
|
|
| ^
|
|
|
|
Did you mean undocumented?
|
|
|
|
|
2024-07-23 15:52:28 +00:00
|
|
|
nix-repl> :doc (import ./doc-comments.nix).constant
|
|
|
|
Attribute `constant`
|
2024-07-09 17:25:45 +00:00
|
|
|
|
2024-07-23 15:52:28 +00:00
|
|
|
… defined at /path/to/tests/functional/repl/doc-comments.nix:27:3
|
2024-07-09 17:25:45 +00:00
|
|
|
|
2024-07-23 15:52:28 +00:00
|
|
|
Firmly rigid.
|
2024-07-09 17:25:45 +00:00
|
|
|
|
2024-07-23 15:52:28 +00:00
|
|
|
nix-repl> :doc (import ./doc-comments.nix).lib.version
|
|
|
|
Attribute `version`
|
2024-07-09 17:25:45 +00:00
|
|
|
|
2024-07-23 15:52:28 +00:00
|
|
|
… defined at /path/to/tests/functional/repl/doc-comments.nix:30:3
|
2024-07-09 17:25:45 +00:00
|
|
|
|
2024-07-23 15:52:28 +00:00
|
|
|
Immovably fixed.
|
2024-07-09 17:25:45 +00:00
|
|
|
|
2024-07-23 15:52:28 +00:00
|
|
|
nix-repl> :doc (import ./doc-comments.nix).lib.attr.empty
|
|
|
|
Attribute `empty`
|
2024-07-09 17:25:45 +00:00
|
|
|
|
2024-07-23 15:52:28 +00:00
|
|
|
… defined at /path/to/tests/functional/repl/doc-comments.nix:33:3
|
2024-07-09 17:25:45 +00:00
|
|
|
|
2024-07-23 15:52:28 +00:00
|
|
|
Unchangeably constant.
|
2024-07-09 17:25:45 +00:00
|
|
|
|
2024-07-23 15:52:28 +00:00
|
|
|
nix-repl> :doc (import ./doc-comments.nix).lib.attr.undocumented
|
|
|
|
Attribute `undocumented`
|
2024-07-09 17:25:45 +00:00
|
|
|
|
2024-07-23 15:52:28 +00:00
|
|
|
… defined at /path/to/tests/functional/repl/doc-comments.nix:35:3
|
2024-07-09 17:25:45 +00:00
|
|
|
|
2024-07-23 15:52:28 +00:00
|
|
|
No documentation found.
|
2024-07-09 17:25:45 +00:00
|
|
|
|
2024-07-23 15:52:28 +00:00
|
|
|
nix-repl> :doc missing
|
2024-07-09 17:25:45 +00:00
|
|
|
error: undefined variable 'missing'
|
|
|
|
at «string»:1:1:
|
|
|
|
1| missing
|
|
|
|
| ^
|
|
|
|
|
2024-07-23 15:52:28 +00:00
|
|
|
nix-repl> :doc constanz
|
2024-07-09 17:25:45 +00:00
|
|
|
error: undefined variable 'constanz'
|
|
|
|
at «string»:1:1:
|
|
|
|
1| constanz
|
|
|
|
| ^
|
|
|
|
|
2024-07-23 15:52:28 +00:00
|
|
|
nix-repl> :doc missing.attr
|
2024-07-09 17:25:45 +00:00
|
|
|
error: undefined variable 'missing'
|
|
|
|
at «string»:1:1:
|
|
|
|
1| missing.attr
|
|
|
|
| ^
|
|
|
|
|
2024-07-23 15:52:28 +00:00
|
|
|
nix-repl> :doc lib.missing
|
2024-07-09 17:25:45 +00:00
|
|
|
error: attribute 'missing' missing
|
|
|
|
at «string»:1:1:
|
|
|
|
1| lib.missing
|
|
|
|
| ^
|
|
|
|
|
2024-07-23 15:52:28 +00:00
|
|
|
nix-repl> :doc lib.missing.attr
|
2024-07-09 17:25:45 +00:00
|
|
|
error: attribute 'missing' missing
|
|
|
|
at «string»:1:1:
|
|
|
|
1| lib.missing.attr
|
|
|
|
| ^
|
|
|
|
|
2024-07-23 15:52:28 +00:00
|
|
|
nix-repl> :doc lib.attr.undocumental
|
2024-07-09 17:25:45 +00:00
|
|
|
error:
|
|
|
|
… while evaluating the attribute 'attr.undocumental'
|
2024-07-15 12:27:09 +00:00
|
|
|
at /path/to/tests/functional/repl/doc-comments.nix:33:3:
|
|
|
|
32| /** Unchangeably constant. */
|
|
|
|
33| lib.attr.empty = { };
|
2024-07-09 17:25:45 +00:00
|
|
|
| ^
|
2024-07-15 12:27:09 +00:00
|
|
|
34|
|
2024-07-09 17:25:45 +00:00
|
|
|
|
|
|
|
error: attribute 'undocumental' missing
|
|
|
|
at «string»:1:1:
|
|
|
|
1| lib.attr.undocumental
|
|
|
|
| ^
|
|
|
|
Did you mean undocumented?
|