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

Allow empty prefix #122

Merged
merged 1 commit into from
Jun 7, 2024
Merged

Allow empty prefix #122

merged 1 commit into from
Jun 7, 2024

Conversation

hsjobeki
Copy link
Collaborator

@hsjobeki hsjobeki commented Apr 25, 2024

Requires #121 to be merged first.

This closes #119

empty prefix or catgeory is possible when this gets merged

@hsjobeki hsjobeki changed the title Feat/prefix Allow empty prefix Apr 25, 2024
@nixos-discourse
Copy link

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/2024-04-25-documentation-team-meeting-notes-122/44080/1

@hsjobeki hsjobeki force-pushed the feat/prefix branch 3 times, most recently from 0d68cb4 to c604349 Compare May 17, 2024 10:07
@hsjobeki hsjobeki requested a review from infinisil May 17, 2024 10:07
@hsjobeki
Copy link
Collaborator Author

hsjobeki commented May 22, 2024

@infinisil should we merge this?

It would allow this PR to move on: NixOS/nixpkgs#305847

It also allows us to utilize doc-comments for things outside of lib where the path prefix doesn't include two dots . i.e. pkgs.*functions.

Copy link
Collaborator

@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.

Hmm I don't like how this breaks rendering when the flag is specified. How about just making it so that the . is only added if the prefix is non-empty?

@hsjobeki
Copy link
Collaborator Author

Hmm I don't like how this breaks rendering when the flag is specified. How about just making it so that the . is only added if the prefix is non-empty?

Just pushed a new commit, to simply allow empty prefixes.

Maybe a future pr could make the seperator configurable

@hsjobeki
Copy link
Collaborator Author

hsjobeki commented Jun 7, 2024

@infinisil any open points? Otherwise could we merge this.

Copy link
Collaborator

@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, sorry for the delay!

Could you do the release yourself? Note that I usually manually edit the changelog in the release to match previous releases, though in the future I'd hope to get more automation for this (see NixOS/nixpkgs-vet#46)

@infinisil infinisil merged commit 3712175 into nix-community:master Jun 7, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support empty prefix
3 participants