-
-
Notifications
You must be signed in to change notification settings - Fork 13.5k
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
lib: Take advantage of section descriptions #268619
Conversation
/* | ||
A partial and basic implementation of GVariant formatted strings. | ||
See [GVariant Format Strings](https://docs.gtk.org/glib/gvariant-format-strings.html) for details. | ||
|
||
:::{.warning} | ||
This API is not considered fully stable and it might therefore | ||
change in backwards incompatible ways without prior notice. | ||
::: | ||
*/ | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@linsui This now gets rendered in the Nixpkgs manual. Note that I changed the "Note" to a "Warning" here, does that sound good?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sounds good to me. :)
{ lib }: | ||
# Operations on attribute sets. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why doesn't nixdoc support #
as a comment character? A design choice?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, I think this was used to be able to distinguish between doc comments and other comments. By using /*
for all doc comments it's clear what's gonna get rendered.
I guess this won't be a concern anymore once RFC 145 is implemented in nixdoc though :)
Description of changes
See https://github.com/nix-community/nixdoc/releases/tag/v2.6.0
This work is sponsored by Antithesis ✨
Things done