rustdoc: fold fields for enum struct variants into a docblock #37728
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
|
|
Please squash your commits then let's merge this! |
QuietMisdreavus
force-pushed
the
rustdoc-enum-struct
branch
from
8e42aba to
fff9216
Compare
|
Ready to roll! |
|
@QuietMisdreavus: Thanks! @bors: r+ rollup |
|
📌 Commit fff9216 has been approved by |
bors
added a commit
that referenced
this pull request
Nov 13, 2016
…meGomez rustdoc: fold fields for enum struct variants into a docblock Per discussion in #37500, this PR updates the enum rendering code to wrap variants with named struct fields in a `docblock` span that is hidden automatically upon load of the page. This gives struct variant fields a clean separation from other enum variants, giving a boost to the readability of such documentation. Preview output is available [on the issue page](#37500 (comment)), but for the sake of completeness I'll include the images here again.  When you initially load the page, there's a line under variants with struct fields letting you know you can click to expand the listing.  If you click to expand, the header and table unfold into a nicely-indented listing. If you want to take a look in your own browser and screen size, [I've got this version hosted on my server](https://shiva.icesoldier.me/doctest/doctest/enum.OldTopicRemoval.html). Fixes #37500 r? @GuillaumeGomez
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.
Per discussion in #37500, this PR updates the enum rendering code to wrap variants with named struct fields in a
docblockspan that is hidden automatically upon load of the page. This gives struct variant fields a clean separation from other enum variants, giving a boost to the readability of such documentation. Preview output is available on the issue page, but for the sake of completeness I'll include the images here again.When you initially load the page, there's a line under variants with struct fields letting you know you can click to expand the listing.
If you click to expand, the header and table unfold into a nicely-indented listing.
If you want to take a look in your own browser and screen size, I've got this version hosted on my server.
Fixes #37500
r? @GuillaumeGomez