-
Notifications
You must be signed in to change notification settings - Fork 104
Open
Description
I've seen several wrong use of tags, where the tag is used as a word in the middle of the sentence:
(**
[f x] @returns an integer with the @param x being a float, @since 1.1, @see that.
*)This issue can be closed by either:
- Accepting the situation as it is, there is already a warning after all.
- Modifying the documentation to give us a good conscience.
- Do a very complicated thing to accept "inline tags" ( ☠️ ).
Here are some examples in the wild:
- sexplib https://github.com/janestreet/sexplib/blob/v0.9.3/src/path.mli#L19
- res https://github.com/mmottl/res/blob/5.0.1/src/strat.ml#L41
- pcre2 https://github.com/camlp5/pcre2-ocaml/blob/7.5.2/src/pcre2.mli#L210
- lacaml https://github.com/mmottl/lacaml/blob/v9.3.2/src/lacaml__utils.ml#L443
- ocaml-irc-client https://github.com/johnelse/ocaml-irc-client/blob/irc-client.0.7.1/src/core/irc_client.mli#L51
- base https://github.com/janestreet/base/blob/v0.9.4/src/string.mli#L393
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels