Merged
Conversation
Contributor
|
Apparently @damiendoligez has said this would go in 4.03 |
3cac9d4 to
340413f
Compare
Contributor
Author
|
I rebased the changes this morning, the failing tests are:
|
Contributor
Author
|
@diml just fixed the camlp4 problem. |
340413f to
6f550f5
Compare
Contributor
|
@damiendoligez Is this ok to merge? |
Member
|
Yes, OK to merge. |
Merged
Gbury
pushed a commit
to Gbury/ocaml
that referenced
this pull request
Jun 21, 2021
Gbury
pushed a commit
to Gbury/ocaml
that referenced
this pull request
Jun 22, 2021
EmileTrotignon
pushed a commit
to EmileTrotignon/ocaml
that referenced
this pull request
Jan 12, 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds support for documentation comments in the following positions:
type 'a with_optionnal = ?optionnal:unit (** optionnal! *) -> 'aval f : ?foo:int (** default [0] *) -> bar:string (** doc *) -> unit (** doc *) -> unittype t = [Foo (** foo! *) |Bar of int * string (** bar? *) ]type t = < foo: int -> int (** foo *) ; bar: int -> int; (** bar *) .. >Currently if warning 50 is enabled it will be emitted for every comment of the examples above.
This is unfortunate because people have not only been asking support for this for a while (see various issues on mantis), but have also been using that style while waiting for tooling support, see:
One should note that the warning inside object types as support was added in ocamldoc with this commit (cf. mantis PR#6274).
The other two cases were not supported but remove an unnecessary limitation and conforms with the style people are already using.