noogle icon indicating copy to clipboard operation
noogle copied to clipboard

Handle mkOverride functions

Open NotAShelf opened this issue 1 year ago • 1 comments

If your Feature is adding / extending more functions https://github.com/hsjobeki/nixpkgs/blob/migrate-doc-comments/lib/modules.nix#L1086C1-L1093C1

Is your feature request related to a problem? Please describe. Functions that set priority (e.g. mkOptionDefault and`mkVMOverride) are not documented on noogle. Leading to empty pages when searched.

Describe the solution you'd like One solution could be to create a category that manually describe the function, and append at the bottom, under a "Priority" title instead of "Detected Type", the priority it will set when used.

Describe alternatives you've considered N/A

Additional context swappy-20240124_123258

NotAShelf avatar Jan 24 '24 09:01 NotAShelf

The proper way would be to write the doc-comment in nixpkgs.

https://github.com/hsjobeki/nixpkgs/blob/540038340b5c4beadaaa2a2bc141fe4420945477/lib/modules.nix#L1150C2-L1150C94

There should be a doc-comment describing the function.

Like with mostly all other lib functions.

hsjobeki avatar Jun 09 '24 19:06 hsjobeki