OxCaml: support for kind abbreviations - #1467
Open
art-w wants to merge 2 commits into
Open
Conversation
panglesd
requested changes
Aug 25, 2026
panglesd
left a comment
Contributor
There was a problem hiding this comment.
Odoc references have this quite particular semantic that they can be "forward reference". So for instance:
type t
(** Abstract but can be created with {!v} *)
val v : unit -> tThe reference to v is made before v is defined.
As a result, in the following example:
kind_ to_be_shadowed = value mod portable
module X : sig
type t : to_be_shadowed
kind_ to_be_shadowed = value_or_null mod non_null global
endWhen clicking on to_be_shadowed associated to the type t, odoc redirects to the second abbrev, value_or_null mod non_null global. I believe the first one, value mod portable, is the one oxcaml would use.
I'll think about what other path you could use. (But tell me if this example is wrong!)
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.
This PR adds support for rendering and linking to kind abbreviations (this introduces a new namespace, similar to types, so a lot of mechanical changes are required!).
As we are currently testing with OxCaml-minus31, there's a small inconvenience that one has to write an explicit
[@@ocaml.doc "..."]to documentkind_abbreviation as the parser was missing anadd_docs_attrs( https://github.com/oxcaml/oxcaml/blob/5.2.0minus-31/parsing/parser.mly#L4123-L4134 ). The oxcaml parser has since been fixed so we'll be able to clean up the test in the near future :)Fix #1443