search

ocaml / ocaml

The core OCaml system: compilers, runtime system, base libraries
https://ocaml.org
Other
5.19k stars 1.06k forks source link

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

Open maroneze opened 3 weeks ago

maroneze commented 3 weeks ago

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 commented 2 weeks ago

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.