Skip to content
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

ocamldoc replaces type variables with meaningless identifiers #7623

Closed
vicuna opened this issue Sep 6, 2017 · 4 comments
Closed

ocamldoc replaces type variables with meaningless identifiers #7623

vicuna opened this issue Sep 6, 2017 · 4 comments

Comments

@vicuna
Copy link

vicuna commented Sep 6, 2017

Original bug ID: 7623
Reporter: @mjambon
Status: closed (set by @xavierleroy on 2017-10-03T12:01:37Z)
Resolution: unable to duplicate
Priority: normal
Severity: trivial
Version: 4.05.0
Category: ocamldoc
Monitored by: @yakobowski

Bug description

It would be good if ocamldoc preserved type variables so that we could have the following in the documentation:

val get : ('key, 'value) Hashtbl.t -> 'key -> 'value option

As it stands, the signature above gets converted into:

val get : ('a, 'b) Hashtbl.t -> 'a -> 'b option

What would it take to get this done?

@vicuna
Copy link
Author

vicuna commented Sep 12, 2017

Comment author: @xclerc

I am unable to reproduce the problem (with a one-line mli file),
with versions 4.02.3 .. 4.05.0; is this declaration part of a
larger signature?

@vicuna
Copy link
Author

vicuna commented Sep 30, 2017

Comment author: @xavierleroy

We need a repro case. Thank you.

@vicuna
Copy link
Author

vicuna commented Oct 1, 2017

Comment author: @mjambon

Indeed, it works for me. I used the command ocamldoc -html toto.mli with the signature above in the file toto.mli i.e. val get : ('key, 'value) Hashtbl.t -> 'key -> 'value option, with ocamldoc 4.04.1.

I reported this because @aantron (Anton Bachin) said it wasn't working, and I remembered from a long time ago that it used to not work.

All my apologies. I'll follow up on the original thread:

ocsigen/lwt#469 (comment)

@vicuna
Copy link
Author

vicuna commented Oct 2, 2017

Comment author: @mjambon

ok, the original reporter can't reproduce the problem either. We can close the issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant