Improve and classify page content #593
Closed
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
Closed
|
Looks good to me. I think we could make the code a little bit regular by adding a few "smart div constructors" and only use those everywhere. This would ensure changes are consistent, and that we cover everything. |
This no longer special cases the markup for declarations
that have no docstring. Before it would be:
div (div.spec div) # With docstring
div.spec # Without docstring
With this patch this becomes:
div (div.spec div) # With docstring
div (div.spec) # Without docstring
The regularity simplifies stylesheets development.
`div (div.spec div)` becomes `div (div.spec div.spec-doc)`.
Unattached trees are classified by `.odoc-unattached` Include divs is classified by `.odoc-include` Declarations are classified by `.odoc-spec`
dbuenzli
force-pushed
the
classify-page-content
branch
from
882686c to
1ca3e98
Compare
|
Format has failed - could you |
|
that's fine! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
This PR is built on top of #589. The relevant commits are from the 15 of february.
It does the following (see the indiviual commits for more details).
.spec-doc(using.dochere was non trivial w.r.t. to the current usage of this class by the stylesheet maybe we can clarify/simplify later)..odoc-content.Regarding 3. I'm not happy about the
.odoc-unattachedasides since they make markup structure differ between modules and mld pages. E.g. you can haveh1 (aside p)in modules and you will haveh1 pin mlds, which makes more cases to treat than needed. But I'll try to unnest them in another PR.