Only show the formatDocs once per group#146
Closed
wilzbach wants to merge 1 commit intodlang:masterfrom
Closed
Conversation
s-ludwig
added a commit
that referenced
this pull request
Mar 5, 2017
This is a more complete approach for #146, combining all declarations in a doc group and removing several redundant sub headings. Also reduces the footprint of the legal footer.
Member
|
I've proposed an alternative approach in #147. The changes here would break pages that contain multiple doc groups and I wanted to make some further reductions. Still far from ideal, but it's getting there slowly. |
Contributor
Author
Awesome! Thanks a lot!
As mentioned this PR was just a naive attempt to explore this ;-) |
s-ludwig
added a commit
that referenced
this pull request
Mar 7, 2017
This is a more complete approach for #146, combining all declarations in a doc group and removing several redundant sub headings. Also reduces the footprint of the legal footer.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
A very naive attempt at fixing #145.
The idea is that when there's a group, the DDOC sections (Parameters, Returns, See also, Examples) should only be shown once.
This still isn't perfect as I wasn't able to group all parameters nicely in my time given today, but I hope it's a good start in a direction of a more visually appealing ddox ;-)
(Note that this was also mentioned as one of the blockers for switching from ddoc to ddox: dlang/dlang.org#1526)
Before:
After: