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

format test directory #1688

Merged
merged 7 commits into from
Oct 30, 2023
Merged

format test directory #1688

merged 7 commits into from
Oct 30, 2023

Conversation

ranocha
Copy link
Member

@ranocha ranocha commented Oct 24, 2023

I ran JuliaFormatter to format our test folder and will check whether it looks correct. Any help with that is appreciated!

@github-actions
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.

test/test_dgmulti_1d.jl Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Oct 25, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (dc0dc1d) 96.14% compared to head (1ac8bd9) 96.14%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1688   +/-   ##
=======================================
  Coverage   96.14%   96.14%           
=======================================
  Files         430      430           
  Lines       34474    34474           
=======================================
  Hits        33142    33142           
  Misses       1332     1332           
Flag Coverage Δ
unittests 96.14% <ø> (ø)

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 ranocha changed the title WIP: format test format test directory Oct 25, 2023
@ranocha ranocha requested a review from sloede October 25, 2023 11:17
@ranocha ranocha marked this pull request as ready for review October 25, 2023 11:17
@ranocha
Copy link
Member Author

ranocha commented Oct 25, 2023

I checked roughly half of the test files. They look okay - if we ignore the issue linked above by Joshua. I think we can go ahead an merge this when tests pass - okay, @sloede?

Copy link
Member

@sloede sloede left a comment

Choose a reason for hiding this comment

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

Unfortunately, due to the special structure with lots of macros etc., formatting test/ does not really improve readability (I'd say it's a lateral movement, at best). However, for the sake of consistency and developer friendly auto-formatting, I say we still go ahead.

LGTM, thanks for tackling it!

@ranocha ranocha merged commit 0f49e5b into main Oct 30, 2023
31 checks passed
@ranocha ranocha deleted the hr/formatting branch October 30, 2023 10:57
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