Don't allow links to hidden pages#1370
Merged
jonludlam merged 3 commits intoocaml:masterfrom Jul 15, 2025
Merged
Conversation
A while back we changed the type of `Path.Resolved.identifier` so we could return `None` for the case where there is genuinely no identifier that can be used. This was initially for to allow paths to core types to be resolved, even though there's no destination for them. This commit extends this idea so that attempting to generate an identifier for a hidden path will result in `None`. Whilst we would prefer not to generate these paths at all, it can happen as a consequence of incorrect canonical paths. Partial fix for ocaml#1369
jonludlam
added a commit
to jonludlam/opam-repository
that referenced
this pull request
Jul 15, 2025
CHANGES: ### Added - Exposed sherlodoc libraries for use in other projects (@jonludlam, ocaml/odoc#1349) - OCaml 5.4.0 support (@Octachron, ocaml/odoc#1355) - New arguments to LaTeX generator, --shorten-beyond-depth and --remove-functor-arg-link (@Octachron, ocaml/odoc#1337) - New experimental markdown generator (@davesnx, ocaml/odoc#1341) ### Changed - Remove cmdliner compatibility layer, no longer needed (@dbuenzli, ocaml/odoc#1328) - Drop support for OCaml < 4.08 (@jonludlam, ocaml/odoc#1300) - Allow referencing libraries from package added in `odoc-config.sexp` (@panglesd, ocaml/odoc#1343) - Use full path in heading labels in LaTeX backend (@Octachron, ocaml/odoc#1332) - Separate page from anchor in LaTeX labels to prevent collisions (@Octachron, ocaml/odoc#1337) ### Fixed - Fix bug in parsing META files when there are no dependencies (@jonludlam, ocaml/odoc#1352) - Fix ocaml/odoc#1335 - incorrect rendering when on medium screen size with no global sidebar (@lukemaurer, ocaml/odoc#1361) - Fixed generation of occurrences for docs CI (@jonludlam, ocaml/odoc#1362) - Partial fix for ocaml/odoc#1369 - ensure that we never create a link to a hidden page (@jonludlam, ocaml/odoc#1370)
jonludlam
added a commit
to jonludlam/opam-repository
that referenced
this pull request
Jul 15, 2025
CHANGES: - Exposed sherlodoc libraries for use in other projects (@jonludlam, ocaml/odoc#1349) - OCaml 5.4.0 support (@Octachron, ocaml/odoc#1355) - New arguments to LaTeX generator, --shorten-beyond-depth and --remove-functor-arg-link (@Octachron, ocaml/odoc#1337) - New experimental markdown generator (@davesnx, ocaml/odoc#1341) - Remove cmdliner compatibility layer, no longer needed (@dbuenzli, ocaml/odoc#1328) - Drop support for OCaml < 4.08 (@jonludlam, ocaml/odoc#1300) - Allow referencing libraries from package added in `odoc-config.sexp` (@panglesd, ocaml/odoc#1343) - Use full path in heading labels in LaTeX backend (@Octachron, ocaml/odoc#1332) - Separate page from anchor in LaTeX labels to prevent collisions (@Octachron, ocaml/odoc#1337) - Fix bug in parsing META files when there are no dependencies (@jonludlam, ocaml/odoc#1352) - Fix ocaml/odoc#1335 - incorrect rendering when on medium screen size with no global sidebar (@lukemaurer, ocaml/odoc#1361) - Fixed generation of occurrences for docs CI (@jonludlam, ocaml/odoc#1362) - Partial fix for ocaml/odoc#1369 - ensure that we never create a link to a hidden page (@jonludlam, ocaml/odoc#1370)
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
1 participant
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 while back we changed the type of
Path.Resolved.identifierso we could returnNonefor the case where there is genuinely no identifier that can be used. This was initially for to allow paths to core types to be resolved, even though there's no destination for them.This commit extends this idea so that attempting to generate an identifier for a hidden path will result in
None. Whilst we would prefer not to generate these paths at all, it can happen as a consequence of incorrect canonical paths.Partial fix for #1369