-
Notifications
You must be signed in to change notification settings - Fork 57
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docgen id is ambiguous #1008
Comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The way docgen currently calculates the
id
is ambiguous ifThis defeats the purpose of having a (supposedly unique) id.
Value / Type Example
generates
Module (Type) Example
generates
Proposal
Either we state an id is only unique per
kind
which will probably confuse people, or we extend the id.The simplest thing would probably be to additionaly include
kind
in the id:<kind>.<modulePath>.<itemName>
.For the above examples:
type.Example.x
/value.Example.x
moduleType.Example.M
/module.Example.M
type.Example.M.x
/value.Example.M.x
P.S: If above seems appropriate, I think I'd be able to send a PR to implement this:
I'd adapt the
makeId
function:rescript-vscode/tools/src/tools.ml
Lines 301 to 302 in a6108b3
to take an additional optional labeled argument
prefix
and call it accordingly.The text was updated successfully, but these errors were encountered: