Fix optional argument rendering in OCaml 5.5 - #1489
Open
jonludlam wants to merge 2 commits into
Open
Conversation
For a module with no mli, OCaml 5.5 wraps the argument types of the inferred arrows in a trivial Tpoly node, which stops odoc recognising the option beneath it: the arguments are marked RawOptional and render as `?force:???`. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
From 5.5 the compiler wraps the argument types of inferred arrows in a trivial Tpoly node, so the loader no longer saw the option constructor and marked the arguments RawOptional, rendering them as `?arg:???`. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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
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.
In OCaml 5.5, optional arguments get wrapped in a
TPolyconstructor, confusing odoc. This results in rendering values such as:This PR fixes this by unwrapping them from the TPoly.