You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
(I was not sure if this Issue should be classified as "Bug report" or "Feature request", feel free to change the tag to something more appropriate)
In the file parsetree.mli, there are many useful comments for ppx rewriter authors.
However, the comments are regular comments, so they are not rendered by any document generator.
In the ppxlib docs, we currently encourage people to open the file to read the comments, which is not very user-friendly. In an effort to improve the ppxlib doc (ocaml-ppx/ppxlib#324), we would prefer to be able to link directly to a generated documentation (cc @pitag-ha).
Now that ocaml/odoc#830 has been merged, doc-comments attached to big records and variant types would render much better than what they used to, in odoc.
Is there a reason to keep the comments in parsetree.mli as regular comments, or would a PR updating these to doc-comments be welcomed?
The text was updated successfully, but these errors were encountered:
I would welcome (and review) an update that lifts comments into documentation comments for any of the compiler-libs module. Beware however, that most of those comments are not syntactically valid as documentation comments.
(I was not sure if this Issue should be classified as "Bug report" or "Feature request", feel free to change the tag to something more appropriate)
In the file parsetree.mli, there are many useful comments for ppx rewriter authors.
However, the comments are regular comments, so they are not rendered by any document generator.
In the
ppxlib
docs, we currently encourage people to open the file to read the comments, which is not very user-friendly. In an effort to improve the ppxlib doc (ocaml-ppx/ppxlib#324), we would prefer to be able to link directly to a generated documentation (cc @pitag-ha).Now that ocaml/odoc#830 has been merged, doc-comments attached to big records and variant types would render much better than what they used to, in odoc.
Is there a reason to keep the comments in
parsetree.mli
as regular comments, or would a PR updating these to doc-comments be welcomed?The text was updated successfully, but these errors were encountered: