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

Fix formatter to older version #1843

Merged
merged 6 commits into from
Feb 14, 2024
Merged

Fix formatter to older version #1843

merged 6 commits into from
Feb 14, 2024

Conversation

ranocha
Copy link
Member

@ranocha ranocha commented Feb 13, 2024

As an alternative to #1842, I fixed the version of JuliaFormatter to an older one.

Copy link
Contributor

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.

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.

@Arpit-Babbar
Copy link
Member

@ranocha
Copy link
Member Author

ranocha commented Feb 13, 2024

Good suggestion, thanks!

Copy link
Member

@Arpit-Babbar Arpit-Babbar left a comment

Choose a reason for hiding this comment

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

The current changes to scripts in utils give me an unexpected ERROR: type Context has no field version. This is a working alternative.

utils/trixi-format-file.jl Outdated Show resolved Hide resolved
utils/trixi-format.jl Outdated Show resolved Hide resolved
Copy link

codecov bot commented Feb 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (fe6a527) 96.38% compared to head (3b97c18) 96.20%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1843      +/-   ##
==========================================
- Coverage   96.38%   96.20%   -0.18%     
==========================================
  Files         455      455              
  Lines       36391    36391              
==========================================
- Hits        35074    35009      -65     
- Misses       1317     1382      +65     
Flag Coverage Δ
unittests 96.20% <ø> (-0.18%) ⬇️

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 and others added 2 commits February 13, 2024 19:22
@ranocha
Copy link
Member Author

ranocha commented Feb 13, 2024

Thanks again!

Copy link
Member

@JoshuaLampert JoshuaLampert left a comment

Choose a reason for hiding this comment

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

The formatter still fails on the util formatter scripts because the lines are too long.

utils/trixi-format-file.jl Outdated Show resolved Hide resolved
utils/trixi-format.jl Outdated Show resolved Hide resolved
@ranocha ranocha merged commit 4369c1c into main Feb 14, 2024
32 checks passed
@ranocha ranocha deleted the ranocha-patch-2 branch February 14, 2024 06:56
ranocha referenced this pull request in SKopecz/PositiveIntegrators.jl Mar 21, 2024
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.

3 participants