Skip to content

Revert doc-comments change to the default profile#1335

Merged
Julow merged 3 commits intoocaml-ppx:masterfrom
Julow:revert_profile_changes
Apr 14, 2020
Merged

Revert doc-comments change to the default profile#1335
Julow merged 3 commits intoocaml-ppx:masterfrom
Julow:revert_profile_changes

Conversation

@Julow
Copy link
Copy Markdown
Collaborator

@Julow Julow commented Apr 14, 2020

This surprised users.

We should release 0.14.1 with this patch.

cc @samoht

@samoht
Copy link
Copy Markdown
Contributor

samoht commented Apr 14, 2020

Why does it change the formatting of vendored code?

appart that LGTM!

Copy link
Copy Markdown
Collaborator

@gpetiot gpetiot left a comment

Choose a reason for hiding this comment

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

Looks good to me, thanks

CHANGES.md Outdated
#### Changes

+ The default for `doc-comments` is changed to `after` (#1335) (Jules Aguillon)
This revert a change introduced in 0.14.0.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Can you mention #1325 here so we can easily jump back and forth between the PRs ? thanks

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

The change is from #1012. The change to the ocamlformat profile is not reverted by this PR.

@gpetiot
Copy link
Copy Markdown
Collaborator

gpetiot commented Apr 14, 2020

Why does it change the formatting of vendored code?

That's because the vendored code uses the conventional profile (as I made it a separate library before), as opposed to the rest of ocamlformat code using the ocamlformat profile (that has not been rolledback)

@Julow
Copy link
Copy Markdown
Collaborator Author

Julow commented Apr 14, 2020

We should probably disable formatting of vendored code. This makes using git subtree impossible and unecessary diffs.

@gpetiot
Copy link
Copy Markdown
Collaborator

gpetiot commented Apr 14, 2020

We should probably disable formatting of vendored code. This makes using git subtree impossible and unecessary diffs.

I was not aware of that, sure we can disable it.

@Julow Julow force-pushed the revert_profile_changes branch from 95957b5 to 60bfa19 Compare April 14, 2020 13:09
@Julow Julow merged commit ee0e83e into ocaml-ppx:master Apr 14, 2020
Julow added a commit to Julow/opam-repository that referenced this pull request Apr 14, 2020
CHANGES:

#### Changes

  + The default for `doc-comments` is changed to `after` (ocaml-ppx/ocamlformat#1335) (Jules Aguillon)
    This reverts a change introduced in 0.14.0 (ocaml-ppx/ocamlformat#1012).

  + Revert deprecation of the `doc-comments` option (ocaml-ppx/ocamlformat#1331) (Jules Aguillon)
    This reverts a change introduced in 0.14.0 (ocaml-ppx/ocamlformat#1293).
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.

4 participants