Fix the type_expr loader in OCaml 4.14 and later #1173
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
Physical equality should not be used on type_expr to detect equality of type variable node, since we are only interested by equality up to equivalence in the union-find structure
Julow
approved these changes
Jul 25, 2024
There was a problem hiding this comment.
Thanks! I've added a test case in Octachron#1 if you agree with it.
I think this deserves a change entry.
|
I have merged the test and added a changes entry, thanks ! |
jonludlam
pushed a commit
that referenced
this pull request
Sep 13, 2024
jonludlam
added a commit
to jonludlam/opam-repository
that referenced
this pull request
Sep 13, 2024
CHANGES: ### Fixed - Fix missing katex headers (@panglesd, ocaml/odoc#1096) - Allow `][` in code blocks, fixing issue ocaml/odoc#1137 (@Julow, ocaml/odoc#1149) This was interpreted as "code blocks with result", which now mandates a delimiter: `{delim@lang[ code ]delim[ result ]}` - Fix misprinting of type variables from ml files for OCaml 4.14 and later (multiple occurences of the same type variable could be named differently) (@Octachron, ocaml/odoc#1173)
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.
Currently, generating documentation from ml files
makes odoc misprint equal type variables as distinc type variables:
starting from OCaml 4.14 .
This issue stems from the uses of physical equalities on non-representative type expressions in the name map of the type expression loader of odoc. Consequently, different type nodes are attributed different names by odoc, even if they belong to the same class of equal-after-unification type nodes.
This issue typically doesn't arise when using mli files, because then we read source type expressions directly, without doing any unification (in most cases?).
This PR fixes this issue by ensuring that the naming maps only use representative type expressions.
Fortunately, this requires mostly tweaks to the
Compatmodule.