-
Notifications
You must be signed in to change notification settings - Fork 184
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
Formatting of code blocks inside documentation comments #478
Comments
This sounds like a good idea to me. If someone wants to manually format a code block, either an attribute could be added to disable ocamlformat, or perhaps a verbatim block could be used. I wonder if it is possible to attach an attribute on the docstring in the source file, or if it is necessary to put the attribute in the code block. The latter would be preferable I think. But either way, I think the first step is to format code blocks, and later see how pressing a disabling solution is. |
Agreed. Personally, I'd be happy to make sure the code snippets are always valid OCaml code so that they can be automatically formatted. |
To do after #721 |
It would be nice if code blocks inside documentation comments where formatted just like normal code so that they don't have to be formatted manually.
The text was updated successfully, but these errors were encountered: