Allow reference to polymorphic variants when possible #1115
Conversation
Signed-off-by: Paul-Elliot <peada@free.fr>
Only when the type declaration has a manifest directly of polymorphic variant definition: ``` type t = [ `A | `B] ``` References must mention the type, but not necessarily include the `` ` ``. Signed-off-by: Paul-Elliot <peada@free.fr>
Signed-off-by: Paul-Elliot <peada@free.fr>
| (* This is needed to ensure that references to polymorphic constructors have | ||
| links that use the right suffix: those resolved references are turned into | ||
| _constructor_ identifiers. *) | ||
| let suffix_for_constructor x = x |
There was a problem hiding this comment.
Polymorphic constructors do not have an ID. When turning a resolved polymorphic constructor reference to an ID, a normal constructor ID is used.
But then, we need to ensure that this id, when turned to an href with anchor, does correspond link to the right place (that is, the page exists (which is always the case but also the html anchor exists).
Anchors are generated in Url.Anchor.polymorphic_variant, more precisely here. This function just tries to "force" the target anchor in IDs for constructor and the anchor for polymorphic constructor to correspond. I can remove it and replace it by a more detailed comment.
I can also add IDs to polymorphic constructors that can be referenced, that means changes to Lang but maybe it is worth it.
|
FYI I'm working in this area right now (looking at Names & associated issues), so I'll have a more concrete view on this when I'm done :-) |
A break from the 3.0 design!
Fixes #907 by allowing references to polymorphic variants when the type is given in the reference and the type's manifest is a polymorphic variant.
The
`in the constructor name is allowed and not mandatory.References without specifying the parent type were not requested in #907 and could be added in another PR.
The last commits illustrate a problem: the polymorphic variants do not have an ID, so the resolved references for polymorphic variants are turned into a normal constructor identifier. This is not ideal.
If needed, the model could be modified to represent for "types whose manifest is a single polymorphic variant" in a way that allows to define ids to the polymorphic variants.
That is a bigger refactoring, but I can do it if you think that is needed.