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

treewide: migrate doc comments #262987

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

hsjobeki
Copy link
Contributor

@hsjobeki hsjobeki commented Oct 23, 2023

Not ready to be merged yet.

Description of changes

Reformat doc-comments according to RFC145.

  • Every doc-comment starts with /** and ends with the regular */
  • nixdoc format is automatically detected and migrated into valid markdown.
  • Content and comment itself is re-indented to be a multiple of 2 (No hitting whitespace anymore yay!)

Some handwork is still needed.

This PR is automatically updated every day.

demo of the rendered comments: https://noogle.dev

  • Every doc-comment is one markdown document.

This breaks compatibility with the existing manual. (Migrations ongoing)

Things done

  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
    • sandbox = relaxed
    • sandbox = true
  • Tested, as applicable:
  • Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
  • Tested basic functionality of all binary files (usually in ./result/bin/)
  • 23.11 Release Notes (or backporting 23.05 Release notes)
    • (Package updates) Added a release notes entry if the change is major or breaking
    • (Module updates) Added a release notes entry if the change is significant
    • (Module addition) Added a release notes entry if adding a new NixOS module
  • Fits CONTRIBUTING.md.

@github-actions github-actions bot force-pushed the migrate-doc-comments branch 4 times, most recently from fd2586d to e0c7b34 Compare March 26, 2024 01:08
@hsjobeki hsjobeki changed the title migrate doc comments treewide: migrate doc comments Mar 28, 2024
@github-actions github-actions bot force-pushed the migrate-doc-comments branch 3 times, most recently from 43caf19 to 358c247 Compare April 2, 2024 01:11
@github-actions github-actions bot force-pushed the migrate-doc-comments branch 7 times, most recently from c86eb3c to ede593a Compare April 20, 2024 01:11
@github-actions github-actions bot force-pushed the migrate-doc-comments branch 2 times, most recently from 78e0dbb to 61f973c Compare April 30, 2024 01:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants