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
Use the tag @since provided by ocamldoc #4831
Comments
Comment author: Julien Signoles In the same way an ocamldoc tag "@modify text" indicating the version number which introduces a backward incompatiblity for an API function would be great. For instance: |
Comment author: @damiendoligez |
Comment author: @zoggy I think additional info should be provided about the change, for example Well, shouldn't this tag be @before instead of @Changed ? : |
Comment author: Julien Signoles I agree with your proposal. |
Comment author: @damiendoligez I have annotated the standard library. Anything that is not marked is unchanged since 3.08.0 or before. Leaving this PR open for the @before tag to be implemented in ocamldoc. |
Original bug ID: 4831
Reporter: Julien Signoles
Assigned to: @zoggy
Status: closed (set by @zoggy on 2010-05-31T11:53:36Z)
Resolution: fixed
Priority: normal
Severity: feature
Fixed in version: 3.12.0+dev
Category: documentation
Monitored by: @ygrek
Bug description
It would be great if the documentation of the ocaml stdlib uses the ocamldoc tag @SInCE in order to know when an element was introduced. Without this information, it is very hard for a library provider to preserve the compatibility with an old ocaml version: remember yourself when any recent feature was introduced is quite impossible.
The text was updated successfully, but these errors were encountered: