Format documentation

[huiyuxie]

See title.

[github-actions]

Review checklist

This checklist is meant to assist creators of PRs (to let them know what reviewers will typically look for) and reviewers (to guide them in a structured review process). Items do not need to be checked explicitly for a PR to be eligible for merging.

Purpose and scope

• The PR has a single goal that is clear from the PR title and/or description.
• All code changes represent a single set of modifications that logically belong together.
• No more than 500 lines of code are changed or there is no obvious way to split the PR into multiple PRs.

Code quality

• The code can be understood easily.
• Newly introduced names for variables etc. are self-descriptive and consistent with existing naming conventions.
• There are no redundancies that can be removed by simple modularization/refactoring.
• There are no leftover debug statements or commented code sections.
• The code adheres to our conventions and style guide, and to the Julia guidelines.

Documentation

• New functions and types are documented with a docstring or top-level comment.
• Relevant publications are referenced in docstrings (see example for formatting).
• Inline comments are used to document longer or unusual code sections.
• Comments describe intent ("why?") and not just functionality ("what?").
• If the PR introduces a significant change or new feature, it is documented in NEWS.md with its PR number.

Testing

• The PR passes all tests.
• New or modified lines of code are covered by tests.
• New or modified tests run in less then 10 seconds.

Performance

• There are no type instabilities or memory allocations in performance-critical parts.
• If the PR intent is to improve performance, before/after time measurements are posted in the PR.

Verification

• The correctness of the code was verified using appropriate tests.
• If new equations/methods are added, a convergence test has been run and the results
  are posted in the PR.

Created with ❤️ by the Trixi.jl community.

[ranocha]

Thanks for initiating this. Did you review all the changes?

[JoshuaLampert]

When we do this, we could also think of using https://github.com/julia-actions/julia-format. This enables automatic suggestions in PRs based on the output of the formatter.

[huiyuxie]

Did you review all the changes?

@ranocha Most changes are about extra spaces. If you don't want this format applied to the docs, please remove the docs path from trixi-format.jl.

[huiyuxie]

@JoshuaLampert It seems tedious to trigger a new PR each time for formatting - I prefer to manually run the formatter.

[JoshuaLampert]

The julia-format action does not create new PRs, but adds suggestions to already existing PRs, which do not follow the formatting rules. I.e. everything you can do without this action is the same as with the action plus you get suggestions, which you just need to accept by clicking on the corresponding button in the GitHub interface. So if you forgot to format it locally, IMO this makes it a little bit more convenient.

[JoshuaLampert]

I am in favor of formatting docs/. Although these are mostly white space changes, I think there are some small issues that should be fixed. See some comments below.

[ranocha]

Thanks for your PR. I agree with @JoshuaLampert - the whitespace changes are fine, but the changes related to comments should be improved in some cases.

[huiyuxie]

I see. Thanks for reviewing @JoshuaLampert @ranocha! I changed the comments based on your comments and also added format to CI. Please check again.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.36%. Comparing base (00ef308) to head (1352147).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2111   +/-   ##
=======================================
  Coverage   96.36%   96.36%           
=======================================
  Files         477      477           
  Lines       37750    37750           
=======================================
  Hits        36376    36376           
  Misses       1374     1374           

Flag	Coverage Δ
unittests	96.36% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[ranocha]

Could you please also update the section https://trixi-framework.github.io/Trixi.jl/stable/styleguide/#automated-source-code-formatting of the docs?

[huiyuxie]

Could you please also update the section https://trixi-framework.github.io/Trixi.jl/stable/styleguide/#automated-source-code-formatting of the docs?

What do you mean - add docs formatting section? Why? Formatting docs is the same as formatting other things.

[huiyuxie]

Review again @ranocha - I am not sure what you mean but I added docs.

[JoshuaLampert]

Thanks @huiyuxie. If you click on the above link, which Hendrik posted, you will see that we have a section in our docs explaining the automated formatting and how to format the code. There it says, e.g.,

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

This is outdated with the current PR because this does not format the docs folder. You could replace that by

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

[huiyuxie]

Thanks @JoshuaLampert!

[JoshuaLampert]

Thanks!

[ranocha]

Thanks a lot!