Don't mix comments and docstrings #2372
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Preliminary to changing its representation.
Comments and docstrings no longer have to be differentiated before formatting. Concatenating "*" to docstrings is no longer necessary. Some comments starting with `(**` were in fact not docstrings. What is a docstring is now dictated by the lexer, which removes this kind of bug.
Julow
added
the
no changelog
Julow
added a commit
to Julow/ocamlformat
that referenced
this pull request
Jun 12, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is a docstring is now dictated by the lexer, which removes a class of bugs and remove some ugly code.
Comments and docstrings can still easily be mixed and the
is_docstringfunction is still necessary to handle ocp-indent-compat. This is improved on in #2371, from which this PR is extracted.