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.

Sign up for GitHub

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

Jump to bottom

treewide: migrate doc comments #262987

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

treewide: migrate doc comments #262987

wants to merge 1 commit into from

Conversation

hsjobeki
Copy link
Contributor

@hsjobeki hsjobeki commented Oct 23, 2023 •
edited
Loading

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 added 6.topic: python 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 6.topic: GNOME GNOME desktop environment and its underlying platform 6.topic: haskell 6.topic: qt/kde 8.has: module (update) This PR changes an existing module in `nixos/` 6.topic: emacs Text editor 6.topic: printing 6.topic: rust 6.topic: ruby 6.topic: vim 6.topic: erlang 6.topic: ocaml 6.topic: fetch 6.topic: stdenv Standard environment 6.topic: TeX Issues regarding texlive and TeX in general 6.topic: lua 6.topic: cinnamon Desktop environment 6.topic: module system About "NixOS" module system internals 6.topic: systemd 6.topic: agda "A dependently typed programming language / interactive theorem prover" 6.topic: vscode 6.topic: lib The Nixpkgs function library labels Oct 23, 2023
@hsjobeki hsjobeki force-pushed the migrate-doc-comments branch from b5cbee6 to c031ca7 Compare October 23, 2023 18:43
@hsjobeki hsjobeki mentioned this pull request Oct 26, 2023
Merged
@hsjobeki hsjobeki mentioned this pull request Nov 13, 2023
Closed
@hsjobeki hsjobeki force-pushed the migrate-doc-comments branch from c031ca7 to 047dce5 Compare November 13, 2023 14:10
@github-actions github-actions bot force-pushed the migrate-doc-comments branch 7 times, most recently from 409059c to f031425 Compare October 26, 2024 00:36
@github-actions github-actions bot force-pushed the migrate-doc-comments branch from f031425 to 8e4d651 Compare November 10, 2024 00:39
@ofborg ofborg bot added 10.rebuild-darwin: 1-10 10.rebuild-darwin: 1 and removed 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin labels Nov 10, 2024
@github-actions github-actions bot force-pushed the migrate-doc-comments branch 4 times, most recently from b51ab2d to 455f585 Compare November 14, 2024 00:38
@github-actions github-actions bot force-pushed the migrate-doc-comments branch 6 times, most recently from 5ea0d91 to 046fb42 Compare November 29, 2024 00:39
@wegank wegank added the 2.status: merge conflict This PR has merge conflicts with the target branch label Dec 10, 2024
@github-actions github-actions bot force-pushed the migrate-doc-comments branch from 046fb42 to 584c376 Compare December 13, 2024 00:41
@ofborg ofborg bot removed the 2.status: merge conflict This PR has merge conflicts with the target branch label Dec 13, 2024
@github-actions github-actions bot force-pushed the migrate-doc-comments branch 4 times, most recently from ccb2d4e to 6034443 Compare December 17, 2024 00:40
@github-actions github-actions bot force-pushed the migrate-doc-comments branch from 6034443 to 96a1ff0 Compare December 18, 2024 00:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
6.topic: agda "A dependently typed programming language / interactive theorem prover" 6.topic: cinnamon Desktop environment 6.topic: emacs Text editor 6.topic: erlang 6.topic: fetch 6.topic: flakes The experimental Nix feature 6.topic: GNOME GNOME desktop environment and its underlying platform 6.topic: haskell 6.topic: lib The Nixpkgs function library 6.topic: lua 6.topic: module system About "NixOS" module system internals 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 6.topic: ocaml 6.topic: php 6.topic: printing 6.topic: python 6.topic: qt/kde 6.topic: ruby 6.topic: rust 6.topic: stdenv Standard environment 6.topic: systemd 6.topic: TeX Issues regarding texlive and TeX in general 6.topic: vim 6.topic: vscode 8.has: module (update) This PR changes an existing module in `nixos/` 10.rebuild-darwin: 1-10 10.rebuild-darwin: 1 10.rebuild-linux: 1-10
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@hsjobeki @infinisil @nixos-discourse @asymmetric @wegank