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

Disable formatting of comments for the janestreet profile. #2461

Merged
merged 1 commit into from
Oct 10, 2023

Conversation

tdelvecchio-jsc
Copy link
Contributor

Jane Street's production ocamlformat does not style comment contents. This PR reverts it (mostly*) to the old behavior.

We will eventually want partial styling of comments (in particular, comment code blocks), but most of our existing code gets poorly mangled by the comment styling, in particular due to non-markup being inferred as mark-up, and code blocks which don't have valid ocaml syntax in them.

*Some minor styling, such as trimming of extra blank lines at the beginning and end of multi-line comments, is preserved.

@gpetiot
Copy link
Collaborator

gpetiot commented Oct 10, 2023

@Julow I'm fine with this but does this conflict with the changes you planned for Jane Street in #2314 or #2371?

Copy link
Collaborator

@Julow Julow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, let's merge!

does this conflict with the changes you planned for Jane Street in #2314 or #2371?

I believe that no. This change is still useful for regular and cinaps comments.

@Julow Julow merged commit 245f525 into ocaml-ppx:main Oct 10, 2023
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

Successfully merging this pull request may close these issues.

3 participants