New syntax (*= ... *) for verbatim comments #2028
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
gpetiot
changed the title
|
Any preference between this syntax and #2009? |
gpetiot
force-pushed
the
eq-verbatim-comment
branch
from
adbe120
to
c6621e8
Compare
|
What's the interaction with mli docstrings? Specifically,
|
No, by default docstrings are not formatted unless
I think only docstrings comments appear in the html doc, not the regular comments.
It would break the odoc parser, we don't plan to add this syntax for docstrings since we do not format them by default (see 1st point). |
Julow
approved these changes
Mar 3, 2022
|
I'm about to merge this PR, @raphael-proust is everything alright with you? |
|
Yep. That's fine. |
This was referenced May 24, 2022
mseri
pushed a commit
to ocaml/opam-repository
that referenced
this pull request
May 26, 2022
CHANGES: ### Removed - Profiles `compact` and `sparse` are now removed (ocaml-ppx/ocamlformat#2075, @gpetiot) - Options `align-cases`, `align-constructors-decl` and `align-variants-decl` are now removed (ocaml-ppx/ocamlformat#2076, @gpetiot) - Option `disable-outside-detected-project` is now removed (ocaml-ppx/ocamlformat#2077, @gpetiot) ### Deprecated - Cancel the deprecations of options that are not set by the preset profiles (ocaml-ppx/ocamlformat#2074, @gpetiot) ### Bug fixes - emacs: Remove temp files in the event of an error (ocaml-ppx/ocamlformat#2003, @gpetiot) - Fix unstable comment formatting around prefix op (ocaml-ppx/ocamlformat#2046, @gpetiot) ### Changes - Qtest comments are not re-formatted (ocaml-ppx/ocamlformat#2034, @gpetiot) - ocamlformat-rpc is now distributed through the ocamlformat package (ocaml-ppx/ocamlformat#2035, @Julow) - Doc-comments code blocks with a language other than 'ocaml' (set in metadata) are not parsed as OCaml (ocaml-ppx/ocamlformat#2037, @gpetiot) - More comprehensible error message in case of version mismatch (ocaml-ppx/ocamlformat#2042, @gpetiot) - The global configuration file (`$XDG_CONFIG_HOME` or `$HOME/.config`) is only applied when no project is detected, `--enable-outside-detected-project` is set, and no applicable `.ocamlformat` file has been found. Global and local configurations are no longer used at the same time. (ocaml-ppx/ocamlformat#2039, @gpetiot) - Set `ocaml-version` to a fixed version (4.04.0) by default to avoid reproducibility issues and surprising behaviours (ocaml-ppx/ocamlformat#2064, @kit-ty-kate) - Split option `--numeric=X-Y` into `--range=X-Y` and `--numeric` (flag). For now `--range` can only be used with `--numeric`. (ocaml-ppx/ocamlformat#2073, ocaml-ppx/ocamlformat#2082, @gpetiot) ### New features - New syntax `(*= ... *)` for verbatim comments (ocaml-ppx/ocamlformat#2028, @gpetiot) - Preserve the begin-end construction in the AST (ocaml-ppx/ocamlformat#1785, @hhugo, @gpetiot) - Preserve position of comments located after the semi-colon of the last element of lists/arrays/records (ocaml-ppx/ocamlformat#2032, @gpetiot) - Option `--print-config` displays a warning when an .ocamlformat file defines redundant options (already defined by a profile) (ocaml-ppx/ocamlformat#2084, @gpetiot)
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.
Follow-up of #1810 and #2009
Introduces a new syntax
(*= ... *)to print comments "verbatim".Here is the preview on tezos' code: https://gitlab.com/tezos/tezos/-/merge_requests/4587