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

Styleguide about automatic formatting leads to massive commit changes #1539

Closed
jmark opened this issue Jun 20, 2023 · 2 comments · Fixed by #1540
Closed

Styleguide about automatic formatting leads to massive commit changes #1539

jmark opened this issue Jun 20, 2023 · 2 comments · Fixed by #1540
Labels
consistency Make Michael happy discussion documentation Improvements or additions to documentation

Comments

@jmark
Copy link
Contributor

jmark commented Jun 20, 2023

The current guidelines https://trixi-framework.github.io/Trixi.jl/stable/styleguide/#automated-source-code-formatting
suggest to format the whole Trixi repo:

julia -e 'using JuliaFormatter; format(".")'.

Doing this leads to massive reformatting of many files.

But the GH CI actually checks only a subset of files:

julia -e 'using JuliaFormatter; format(["benchmark", "ext", "src", "utils"])'

Question is: Suggest the latter in the styleguides or enforce formatting for all files in Trixi?

@jmark jmark added documentation Improvements or additions to documentation discussion consistency Make Michael happy labels Jun 20, 2023
@sloede
Copy link
Member

sloede commented Jun 20, 2023

You are right, the docs are a little ahead of the status quo! The examples are currently being formatted in #1531, and the docs will follow after. Feel free to create a PR to fix the docs to the current status quo 👍

jmark added a commit that referenced this issue Jun 20, 2023
Updated the formatting command line fixing the issue #1539
@jmark
Copy link
Contributor Author

jmark commented Jun 20, 2023

Done.

@ranocha ranocha linked a pull request Jun 20, 2023 that will close this issue
ranocha pushed a commit that referenced this issue Jun 20, 2023
* Update styleguide.md

Updated the formatting command line fixing the issue #1539

* Update styleguide.md

Removed superfluous whitespace.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
consistency Make Michael happy discussion documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants