-
-
Notifications
You must be signed in to change notification settings - Fork 14k
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
doc: migrate filesets to doc-comment format #303811
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@hsjobeki I didn't make suggestions to fix the line indentation because I'm assuming you want to get these fixed in the tooling you're using for the conversion. The only suggestion I made is for a bit of extra content in the description of one of the functions, just because that function's description mentions two arguments, but only one is caught by the tooling.
@DanielSidhion I'll add the indentation fixes to the tooling. Most of it was done manually anyways. I dont have tooling to automatically migrate structured arguments. We must manually revise the file now. Migration cannot run twice. Maybe i should add a markdown formatter, but had bad experience in nixdoc with it. I'll think about the formatting issues. |
1150cd5
to
2526593
Compare
2526593
to
8cb4334
Compare
@DanielSidhion indentation should be fine now. (also needed to rebase) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the changes! Also rendered the manual locally and checked that nothing was broken.
Description of changes
lib.filesets comments migrated to doc-comments.
Manual steps:
Things done
nix.conf
? (See Nix manual)sandbox = relaxed
sandbox = true
nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD"
. Note: all changes have to be committed, also see nixpkgs-review usage./result/bin/
)Add a 👍 reaction to pull requests you find important.