doc: de-clutter documentation with fake-variadics #101
Conversation
This file contains hidden or 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
Currently the doc for `Zeroable` and `ZeroableOption` are filled with the generated impl of tuples and fn pointers. Use the internal "fake_variadics" feature to improve the rendered quality. This makes use of an internal feature, however this is of minimal risk as it's for documentation only, not activated during normal build, and can be removed at any time. This feature is already used by serde and bevy to improve documentation quality. Signed-off-by: Gary Guo <gary@garyguo.net>
BennoLossin
approved these changes
Jan 18, 2026
Member
BennoLossin
left a comment
BennoLossin
left a comment
There was a problem hiding this comment.
Oh this is great! I didn't know this feature existed. Do you know if there is a similar feature for integers? I'm very much in favor of doing this.
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.
Currently the doc for
ZeroableandZeroableOptionare filled with the generated impl of tuples and fn pointers. Use the internal "fake_variadics" feature to improve the rendered quality.This makes use of an internal feature, however this is of minimal risk as it's for documentation only, not activated during normal build, and can be removed at any time. This feature is already used by serde and bevy to improve documentation quality.
@BennoLossin I'd like to know your opinion on this before sending off to the list. The fake_variadics is optional, we can also just use
doc(hidden)only and leave only one shown. However, it does look nicer with variadics.