Allow referencing labels in the top comment #771
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
Julow
approved these changes
Nov 4, 2021
There was a problem hiding this comment.
This changes the behavior of the "second part of the first comment" (defined in #640) in the case of functors.
The page rendered like this before this PR:
{0 Module M.X}
Synopsis.
{TOC}
# The "content" starts here
{1 The second part of the first comment}
{1 Parameters}
module Arg : ...
{1 Signature}
now, it is rendered like if it was a separate floating comment:
{0 Module M.X}
Synopsis.
{TOC}
# The "content" starts here
{1 Parameters}
module Arg : ...
{1 Signature}
{1 The second part of the first comment}
I think this change is fine. If something needs to be improved here, it's the rendering of the functor parameters. (for example using stronger headings)
test/generators/html/odoc.css
Outdated
| @@ -0,0 +1,782 @@ | |||
| @charset "UTF-8"; | |||
There was a problem hiding this comment.
I think we should include these files as symlink, otherwise, they'd get out of date.
There was a problem hiding this comment.
ah good point yes! I'll fix that.
This commit splits the first comment in a signature at the first heading. This means everything before will be put into the preamble of the page, and the rest of the comment becomes part of the signature. Fixes: ocaml#740
jonludlam
changed the title
jonludlam
added a commit
to jonludlam/opam-repository
that referenced
this pull request
Nov 26, 2021
CHANGES: Bugs fixed - Man page renderer fails to output pages that have children (@jonludlam, @Julow, ocaml/odoc#766) - Fix resolution of unprefixed references to pages (@Julow, ocaml/odoc#755) - Fix reporting of ambiguous labels (@Julow, @jonludlam, ocaml/odoc#773, ocaml/odoc#781) - Allow referencing of labels in the top comment (@jonludlam, ocaml/odoc#771) Additions - Strip unquoted spaces in identifiers for a more flexible reference syntax (@lubega-simon, @panglesd, ocaml/odoc#783) - Add context to messages raised in expansions of includes (@Julow, ocaml/odoc#780)
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.
This PR splits the first comment in a signature at the firstheading. This means everything before will be put into the preamble of the page, and the rest of the comment becomes part of the signature. Since the top comment has never been put into the environment, previously this meant that the labels couldn't be referenced. Now they are part of the signature this starts to work.
Fixes #740