Skip to content

Conversation

@DanielDoehring
Copy link
Member

@DanielDoehring DanielDoehring added the documentation Improvements or additions to documentation label Aug 22, 2025
@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 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.

@DanielDoehring DanielDoehring changed the title Fix variable name from 'v1' to 'v' Fix variable name from v1 to v Aug 22, 2025
@codecov
Copy link

codecov bot commented Aug 22, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.76%. Comparing base (5593691) to head (408e87e).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2527   +/-   ##
=======================================
  Coverage   96.76%   96.76%           
=======================================
  Files         512      512           
  Lines       42391    42391           
=======================================
  Hits        41016    41016           
  Misses       1375     1375           
Flag Coverage Δ
unittests 96.76% <ø> (ø)

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.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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.

In the docstring of CompressibleEulerEquations1D we use $$v_1$$. Wouldn't it make more sense to also use $$v_1$$ everywhere for Navier-Stokes to stay consistent?

@DanielDoehring
Copy link
Member Author

In the docstring of CompressibleEulerEquations1D we use v 1 . Wouldn't it make more sense to also use v 1 everywhere for Navier-Stokes to stay consistent?

Makes sense to me 👍 !

@DanielDoehring DanielDoehring changed the title Fix variable name from v1 to v Fix variable name from v to v_1 Aug 22, 2025
JoshuaLampert
JoshuaLampert previously approved these changes Aug 22, 2025
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.

Thanks!

ranocha
ranocha previously approved these changes Aug 22, 2025
JoshuaLampert
JoshuaLampert previously approved these changes Aug 22, 2025
@DanielDoehring DanielDoehring dismissed stale reviews from JoshuaLampert and ranocha via 221fcd4 August 22, 2025 10:02
JoshuaLampert
JoshuaLampert previously approved these changes Aug 22, 2025
ranocha
ranocha previously approved these changes Aug 22, 2025
Copy link
Member

@andrewwinters5000 andrewwinters5000 left a comment

Choose a reason for hiding this comment

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

Just a few minor comments that clarify what is being done

Copy link
Contributor

@jlchan jlchan left a comment

Choose a reason for hiding this comment

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

The v -> v_1 changes seem good to me, but the gradient comments seem like they needs a bit more discussion.

@DanielDoehring
Copy link
Member Author

The v -> v_1 changes seem good to me, but the gradient comments seem like they needs a bit more discussion.

Okay, lets do the following: I strip the gradient stuff from this PR, put everything into #2528 and then we merge here?

Co-authored-by: Andrew Winters <andrew.ross.winters@liu.se>
@ranocha ranocha merged commit f7aff1b into main Aug 23, 2025
39 checks passed
@ranocha ranocha deleted the DanielDoehring-patch-1 branch August 23, 2025 06:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants