search

nix-community / nixdoc

Tool to generate documentation for Nix library functions [maintainer=@infinisil]
GNU General Public License v3.0
123 stars 15 forks source link

Prove that switching from recursive attrsets to explicit `inherit` style doesn't impact documentation #111

Closed philiptaron closed 5 months ago

philiptaron commented 5 months ago

@infinisil raised a concern in https://github.com/NixOS/nixpkgs/pull/293901 that the switch to this style would cause docs not to be generated. Not so!

Modifying test/lib-debug.nix impacts test_description_of_lib_debug and its snapshot test.

The extraction of the helpers from traceSeqN proves that things not inherited in the final attrset do not impact the documentation.