Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Handle mkOverride functions #77

Open
NotAShelf opened this issue Jan 24, 2024 · 1 comment
Open

Handle mkOverride functions #77

NotAShelf opened this issue Jan 24, 2024 · 1 comment

Comments

@NotAShelf
Copy link

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

@hsjobeki
Copy link
Collaborator

hsjobeki commented Jun 9, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants