Skip to content
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

The file parsetree.mli is mostly documented in regular comments (instead of doc-comments) #11071

Closed
panglesd opened this issue Feb 28, 2022 · 3 comments

Comments

@panglesd
Copy link
Contributor

(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?

@Octachron
Copy link
Member

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.

@panglesd
Copy link
Contributor Author

Thanks @Octachron!

I opened the PR with the lifted comments : #11107.

@Octachron
Copy link
Member

Fixed by the merge of #11107 and deployed at https://ocaml.org/api/compilerlibref/Parsetree.html .

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants