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

Since tag for a module not showing in the online API, if coming from Stdlib #13106

Open
maroneze opened this issue Apr 22, 2024 · 1 comment
Open

Comments

@maroneze
Copy link
Contributor

After porting some code to 5.1, I spent some time trying to understand some weird error messages, until I realized the issue was the new Stdlib.Type module that conflicted with my type.ml.

Unfortunately, the online manual API page does not show the @since 5.1 tag, which is present in the file since it has been created.

Actually, it's not exactly true: my colleague just showed me that one version of the API page does show the since tag: https://ocaml.org/manual/5.1/api/Type.html

However, via Google I get either https://v2.ocaml.org/api/Stdlib.Type.html, or https://ocaml.org/manual/5.1/api/Stdlib.Type.html, which unfortunately do not show the since tag at the beginning.

Is this a known issue?

@Octachron
Copy link
Member

The handling of module-level since tag is unfortunately a bit quirky in ocamldoc, that should be fixed once we switch to odoc for the documentation published on ocaml.org.

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

No branches or pull requests

2 participants