Fix: types on named arguments were wrapped incorrectly when preceding comments#1124
Fix: types on named arguments were wrapped incorrectly when preceding comments#1124gpetiot merged 4 commits intoocaml-ppx:masterfrom gpetiot:fix-named-arguments
Conversation
CHANGES.md
Outdated
|
|
||
| #### Bug fixes | ||
|
|
||
| + Fix types on named arguments are wrapped incorrectly when preceding comments (#1124) (Guillaume Petiot) |
There was a problem hiding this comment.
Should we start to write reporter name ?
If yes, we should break the line before the pr number and maybe remove the parenthesis.
What do you think ?
@NathanReb
There was a problem hiding this comment.
I'm not sure it is very useful, even the contributor's name is redundant with the PR's number to me, unless you want to grep on someone's name (what for?)
But I'm not opposed to follow a new standard, if dictated by https://github.com/ocaml/ocaml-library-standard for example.
There was a problem hiding this comment.
I'm not sure this project is about changelogs but I agree, we should follow a standard.
There is https://keepachangelog.com/en/1.0.0/ which only show external contributors and no PR#.
Also, OCaml https://github.com/ocaml/ocaml/blob/trunk/Changes (PR#, contributor, reviewers and sometimes reporter, lots of details and sections)
and Dune https://github.com/ocaml/dune/blob/master/CHANGES.md (PR#, issue#, contributor and some details).
I don't have strong opinions on which format is better. I like OCaml's for the details and the section.
There was a problem hiding this comment.
Having the reviewers makes sense for OCaml given the number of contributors they have, so you know who to blame, it looks like an overkill for ocamlformat for now. But I agree that more details on what a PR does can't hurt.
There was a problem hiding this comment.
PR number is a must have I'd say because it allows one to dig deeper if they don't understand or want to know all the details about a specifc change.
Imo, the author name is just a way to credit the contributors but I still like it. I agree it's not as strictly necessary as the PR number(s?).
|
I don't have strong opinions on which format is better. I like OCaml's for the details and the section.
I don't have strong views on this, but I do find the PR# to be useful info to find discussion after the fact. I also think that it is good to acknowledge reporters who have gone to the effort to construct and send repro cases or make clear arguments supporting suggestions, etc. That is very valuable effort that external contributors can make. And acknowledging PRs authored by external contributors (at least) is also a good practice for community health I think.
|
CHANGES: #### New features + Add an option `--margin-check` to emit a warning if the formatted output exceeds the margin (ocaml-ppx/ocamlformat#1110) (Guillaume Petiot) + Preserve comment indentation when `wrap-comments` is unset (ocaml-ppx/ocamlformat#1138, ocaml-ppx/ocamlformat#1159) (Jules Aguillon) + Improve error messages (ocaml-ppx/ocamlformat#1147) (Jules Aguillon) + Display standard output in the emacs plugin even when ocamlformat does not fail (ocaml-ppx/ocamlformat#1189) (Guillaume Petiot) #### Removed + Remove `ocamlformat_reason` (ocaml-ppx/ocamlformat#254, ocaml-ppx/ocamlformat#1185) (Etienne Millon). This tool has never been released to opam, has no known users, and overlaps with what `refmt` can do. + Remove `ocamlformat-diff` (ocaml-ppx/ocamlformat#1205) (Guillaume Petiot) This tool has never been released to opam, has no known users, and overlaps with what `merge-fmt` can do. #### Packaging + Work with base v0.13.0 (ocaml-ppx/ocamlformat#1163) (Jules Aguillon) #### Bug fixes + Fix placement of comments just before a '|' (ocaml-ppx/ocamlformat#1203) (Jules Aguillon) + Fix build version detection when building in the absence of a git root (ocaml-ppx/ocamlformat#1198) (Anil Madhavapeddy) + Fix wrapping of or-patterns in presence of comments with `break-cases=fit` (ocaml-ppx/ocamlformat#1167) (Jules Aguillon) This also fixes an unstable comment bug in or-patterns + Fix an unstable comment bug in variant declarations (ocaml-ppx/ocamlformat#1108) (Jules Aguillon) + Fix: break multiline comments (ocaml-ppx/ocamlformat#1122) (Guillaume Petiot) + Fix: types on named arguments were wrapped incorrectly when preceding comments (ocaml-ppx/ocamlformat#1124) (Guillaume Petiot) + Fix the indentation produced by max-indent (ocaml-ppx/ocamlformat#1118) (Guillaume Petiot) + Fix break after Psig_include depending on presence of docstring (ocaml-ppx/ocamlformat#1125) (Guillaume Petiot) + Remove some calls to if_newline and break_unless_newline and fix break before closing brackets (ocaml-ppx/ocamlformat#1168) (Guillaume Petiot) + Fix unstable cmt in or-pattern (ocaml-ppx/ocamlformat#1173) (Guillaume Petiot) + Fix location of comment attached to the underscore of an open record (ocaml-ppx/ocamlformat#1208) (Guillaume Petiot) + Fix parentheses around optional module parameter (ocaml-ppx/ocamlformat#1212) (Christian Barcenas) + Fix grouping of horizontally aligned comments (ocaml-ppx/ocamlformat#1209) (Guillaume Petiot) + Fix dropped comments around module pack expressions (ocaml-ppx/ocamlformat#1214) (Jules Aguillon) + Fix regression of comment position in list patterns (ocaml-ppx/ocamlformat#1141) (Josh Berdine) + Fix: adjust definition of Location.is_single_line to reflect margin (ocaml-ppx/ocamlformat#1102) (Josh Berdine) #### Documentation + Fix documentation of option `version-check` (ocaml-ppx/ocamlformat#1135) (Wilfred Hughes) + Fix hint when using `break-separators=after-and-docked` (ocaml-ppx/ocamlformat#1130) (Greta Yorsh)
Fix #1123
no diff with test_branch.sh on any profile.