Fix reference urls to sections #676
Merged
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
- The two references in N are wrong, both are pointing to '../index.html#B', should be '#B' and '../M/index.html#B'. - Label defined in top-comment can't be referenced. - Reference paths are correct.
It was using the wrong parent (which defines the containing page).
Julow
commented
May 12, 2021
| match parent with | ||
| | #Path.source as parent -> mk ~kind:"section" parent str_name | ||
| | `CoreType _ -> Error (Unexpected_anchor "core_type label parent") | ||
| | `Type (gp, _) -> mk ~kind:"section" gp str_name) |
There was a problem hiding this comment.
Identifier.LabelParent.t should probably not contain types.
There was a problem hiding this comment.
Label are section names, not fields. I don't expect a heading (sections are only defined by headings) attached to anything inside a type (classes are covered in the Path.source case).
| [{"`Resolved":{"`Label":[{"`Identifier":{"`Module":[{"`Root":[{"`RootPage":"test"},"Test"]},"M"]}},"B"]}},[]] | ||
| [{"`Resolved":{"`Identifier":{"`Label":[{"`Root":[{"`RootPage":"test"},"Test"]},"A"]}}},[{"`Word":"First"},"`Space",{"`Word":"label"}]] | ||
| [{"`Resolved":{"`Identifier":{"`Label":[{"`Root":[{"`RootPage":"test"},"Test"]},"B"]}}},[{"`Word":"Floating"},"`Space",{"`Word":"label"}]] | ||
| [{"`Dot":[{"`Root":["M","`TUnknown"]},"C"]},[]] |
There was a problem hiding this comment.
That's an other bug, references to labels in top-comments don't resolve.
Before OCaml 4.07, top-comments weren't recognized by the loader,
causing the following diff. This is potentially a bug.
--- a/../../../default/test/xref2/labels.t/run.t
+++ b/test/xref2/labels.t/run.t.corrected
@@ -8,9 +8,8 @@ Some are not in order because the 'doc' field appears after the rest in the outp
$ odoc_print test.odocl | jq -c '.. | .["`Heading"]? | select(.) | .[1]["`Label"]'
[{"`Root":[{"`RootPage":"test"},"Test"]},"B"]
- [{"`Module":[{"`Root":[{"`RootPage":"test"},"Test"]},"M"]},"D"]
[{"`Module":[{"`Root":[{"`RootPage":"test"},"Test"]},"M"]},"B"]
- [{"`Module":[{"`Root":[{"`RootPage":"test"},"Test"]},"M"]},"C"]
+ [{"`Module":[{"`Root":[{"`RootPage":"test"},"Test"]},"M"]},"D"]
[{"`Module":[{"`Root":[{"`RootPage":"test"},"Test"]},"N"]},"B"]
[{"`Root":[{"`RootPage":"test"},"Test"]},"A"]
@@ -23,9 +22,9 @@ We expect resolved references and the heading text filled in.
[{"`Resolved":{"`Identifier":{"`Label":[{"`Root":[{"`RootPage":"test"},"Test"]},"A"]}}},[{"`Word":"First"},"`Space",{"`Word":"label"}]]
[{"`Resolved":{"`Identifier":{"`Label":[{"`Root":[{"`RootPage":"test"},"Test"]},"B"]}}},[{"`Word":"Floating"},"`Space",{"`Word":"label"}]]
[{"`Dot":[{"`Root":["M","`TUnknown"]},"C"]},[]]
- [{"`Resolved":{"`Label":[{"`Identifier":{"`Module":[{"`Root":[{"`RootPage":"test"},"Test"]},"M"]}},"D"]}},[]]
+ [{"`Dot":[{"`Root":["M","`TUnknown"]},"D"]},[]]
[{"`Resolved":{"`Label":[{"`Identifier":{"`Module":[{"`Root":[{"`RootPage":"test"},"Test"]},"M"]}},"B"]}},[]]
- [{"`Resolved":{"`Label":[{"`Identifier":{"`Module":[{"`Root":[{"`RootPage":"test"},"Test"]},"N"]}},"B"]}},[]]
+ [{"`Dot":[{"`Root":["N","`TUnknown"]},"B"]},[]]
$ odoc html-generate --indent -o html test.odocl
Julow
commented
May 17, 2021
| (cram | ||
| (deps %{bin:odoc} %{bin:odoc_print} %{bin:compile}) | ||
| (enabled_if | ||
| (>= %{ocaml_version} 4.07.0)))) |
There was a problem hiding this comment.
Before 4.07, labels in top-comments were ignored by the loader. This is probably a bug.
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.
Fix #659
It was pointing to the wrong parent page.