1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
Nix <nix version>
Type :? for help.
nix-repl> :l doc-comments.nix
Added <number omitted> variables.
nix-repl> :doc constant
error: value does not have documentation
nix-repl> :doc lib.version
Attribute `version`
… defined at /path/to/tests/functional/repl/doc-comments.nix:47:3
Immovably fixed.
nix-repl> :doc lib.attr.empty
Attribute `empty`
… defined at /path/to/tests/functional/repl/doc-comments.nix:52:3
Unchangeably constant.
nix-repl> :doc lib.attr.undocument
error:
… while evaluating the attribute 'attr.undocument'
at /path/to/tests/functional/repl/doc-comments.nix:52:3:
51| */
52| lib.attr.empty = { };
| ^
53|
error: attribute 'undocument' missing
at «string»:1:1:
1| lib.attr.undocument
| ^
Did you mean undocumented?
nix-repl> :doc (import ./doc-comments.nix).constant
Attribute `constant`
… defined at /path/to/tests/functional/repl/doc-comments.nix:42:3
Firmly rigid.
nix-repl> :doc (import ./doc-comments.nix).lib.version
Attribute `version`
… defined at /path/to/tests/functional/repl/doc-comments.nix:47:3
Immovably fixed.
nix-repl> :doc (import ./doc-comments.nix).lib.attr.empty
Attribute `empty`
… defined at /path/to/tests/functional/repl/doc-comments.nix:52:3
Unchangeably constant.
nix-repl> :doc (import ./doc-comments.nix).lib.attr.undocumented
Attribute `undocumented`
… defined at /path/to/tests/functional/repl/doc-comments.nix:54:3
No documentation found.
nix-repl> :doc missing
error: undefined variable 'missing'
at «string»:1:1:
1| missing
| ^
nix-repl> :doc constanz
error: undefined variable 'constanz'
at «string»:1:1:
1| constanz
| ^
nix-repl> :doc missing.attr
error: undefined variable 'missing'
at «string»:1:1:
1| missing.attr
| ^
nix-repl> :doc lib.missing
error: attribute 'missing' missing
at «string»:1:1:
1| lib.missing
| ^
nix-repl> :doc lib.missing.attr
error: attribute 'missing' missing
at «string»:1:1:
1| lib.missing.attr
| ^
nix-repl> :doc lib.attr.undocumental
error:
… while evaluating the attribute 'attr.undocumental'
at /path/to/tests/functional/repl/doc-comments.nix:52:3:
51| */
52| lib.attr.empty = { };
| ^
53|
error: attribute 'undocumental' missing
at «string»:1:1:
1| lib.attr.undocumental
| ^
Did you mean undocumented?
|
