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

Doc: migrate lib.strings to commonmark #323843

Merged
merged 1 commit into from
Jul 27, 2024
Merged

Doc: migrate lib.strings to commonmark #323843

merged 1 commit into from
Jul 27, 2024

Conversation

hsjobeki
Copy link
Contributor

@hsjobeki hsjobeki commented Jul 1, 2024

Description of changes

Migration to commonmark / doc-comments according to rfc145

Also added missing types #type and inputs # inputs where i found mistakes.

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.11 Release Notes (or backporting 23.11 and 24.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.

Add a 👍 reaction to pull requests you find important.

@hsjobeki hsjobeki requested a review from infinisil as a code owner July 1, 2024 16:30
@github-actions github-actions bot added the 6.topic: lib The Nixpkgs function library label Jul 1, 2024
@hsjobeki hsjobeki requested a review from DanielSidhion July 1, 2024 16:30
@hsjobeki hsjobeki force-pushed the doc/lib-strings-commonmark branch from c318d84 to 7e1642c Compare July 1, 2024 16:38
@ofborg ofborg bot added 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 1-10 labels Jul 1, 2024
infinisil
infinisil approved these changes Jul 25, 2024
View reviewed changes
Copy link
Member

@infinisil infinisil left a comment

Choose a reason for hiding this comment

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

I did a spot check and couldn't find any issues with this, nice work as always! Unfortunately it needs a rebase after #315411 (which also added some new docs in the old format), didn't see this PR until after I merged it, sorry!

@hsjobeki
Copy link
Contributor Author

I did a spot check and couldn't find any issues with this, nice work as always! Unfortunately it needs a rebase after #315411 (which also added some new docs in the old format), didn't see this PR until after I merged it, sorry!

Ah yeah. Could we merge this; i'll rebase it the next days. If little mistakes where found afterwards we can make small fixes afterwards if that sound okay to you.

@infinisil
Copy link
Member

@hsjobeki Sounds good to me!

@hsjobeki hsjobeki force-pushed the doc/lib-strings-commonmark branch from 7e1642c to d50c7e1 Compare July 27, 2024 12:30
@hsjobeki hsjobeki force-pushed the doc/lib-strings-commonmark branch from d50c7e1 to aba0f17 Compare July 27, 2024 12:39
@hsjobeki
Copy link
Contributor Author

ping @infinisil. Rebase done. I also migrated the trim and trimWith function docs.

infinisil
infinisil approved these changes Jul 27, 2024
View reviewed changes
Copy link
Member

@infinisil infinisil left a comment

Choose a reason for hiding this comment

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

Looking good, thanks!

@infinisil infinisil merged commit 90d83ba into NixOS:master Jul 27, 2024
9 of 10 checks passed
@MattSturgeon MattSturgeon mentioned this pull request Nov 7, 2024
Merged
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@infinisil infinisil infinisil approved these changes

@DanielSidhion DanielSidhion Awaiting requested review from DanielSidhion

Assignees
No one assigned
Labels
6.topic: lib The Nixpkgs function library 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 1-10
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@hsjobeki @infinisil