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

adds block_args for autogenerated ids from trustworthy sources #281212

Merged
merged 1 commit into from
Jan 29, 2024

Conversation

hsjobeki
Copy link
Contributor

@hsjobeki hsjobeki commented Jan 15, 2024

Description of changes

Add option to autogenerate heading ids. This is needed if we want to support regular commonmark documentation generated from nix source code. People are not expected to place heading ids in their code comments.

This PR resolves:

#280514

Which is needed for implementing rfc145 in nixpkgs.

@pennae. Thank you a lot for your help with this PR.

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/)
  • 24.05 Release Notes (or backporting 23.05 and 23.11 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.

Add a 👍 reaction to pull requests you find important.

Copy link
Contributor

@pennae pennae left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks reasonable enough :)

@hsjobeki hsjobeki force-pushed the nrd/auto-id-prefix branch 4 times, most recently from c21ac0e to d59c8cf Compare January 21, 2024 14:53
@hsjobeki hsjobeki requested a review from pennae January 21, 2024 14:59
@hsjobeki
Copy link
Contributor Author

hsjobeki commented Jan 21, 2024

@pennae can you have a look if it looks clean enough for merging. 😃

Copy link
Contributor

@pennae pennae left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks pretty reasonable :)

@pennae pennae force-pushed the nrd/auto-id-prefix branch from 96cc68a to 48a2178 Compare January 29, 2024 21:31
Copy link
Contributor

@pennae pennae left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed a few missing type annotations to make tests happy. looks fine otherwise :)

@pennae pennae merged commit 1d68d6d into NixOS:master Jan 29, 2024
20 checks passed
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.

2 participants