lib: Take advantage of section descriptions #268619
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
6.topic: module system
infinisil
commented
Nov 20, 2023
Comment on lines
+1
to
+10
| /* | ||
| 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.
@linsui This now gets rendered in the Nixpkgs manual. Note that I changed the "Note" to a "Warning" here, does that sound good?
bjornfor
reviewed
Nov 20, 2023
| { lib }: | ||
| # Operations on attribute sets. |
There was a problem hiding this comment.
Why doesn't nixdoc support # as a comment character? A design choice?
There was a problem hiding this comment.
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 :)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of changes
See https://github.com/nix-community/nixdoc/releases/tag/v2.6.0
This work is sponsored by Antithesis ✨
Things done