Skip to content

Conversation

@JoshuaLampert
Copy link
Member

@JoshuaLampert JoshuaLampert commented Feb 15, 2025

Close #2282.

Let's see if I messed up something.

For potential future reference, I used the following script to do the replacement automatically:
dirs = ["examples", "test", "docs", "benchmark"]
for dir in dirs
    for (root, _, files) in walkdir(dir)
        for file in files
            if endswith(file, ".jl") || endswith(file, ".md")
                filename = joinpath(root, file)
                (tmppath, tmpio) = mktemp()
                open(filename) do io
                    for line in readlines(io)
                        if contains(line, "save_everystep = false")
                            line = replace(line, "save_everystep = false" => "ode_default_options()...")
                        end
                        # ode_default_options() needs a semicolon to separate positional args from kwargs
                        # replacing the last comma in the first line of the solve call by a semicolon
                        # should fix most of them
                        if (contains(line, "solve(ode") || contains(line, "init(ode")) && !contains(line, ";") && endswith(line, ",")
                           line = line[1:(end - 1)] * ";"
                        end
                        println(tmpio, line)
                    end
                end
                close(tmpio)
                mv(tmppath, filename, force = true)
            end
        end
    end
end

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

@JoshuaLampert JoshuaLampert added the consistency Make Michael happy label Feb 15, 2025
JoshuaLampert and others added 7 commits February 15, 2025 12:16
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@codecov
Copy link

codecov bot commented Feb 15, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.87%. Comparing base (f47c5ed) to head (e69f237).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2286   +/-   ##
=======================================
  Coverage   96.87%   96.87%           
=======================================
  Files         490      490           
  Lines       39507    39507           
=======================================
  Hits        38272    38272           
  Misses       1235     1235           
Flag Coverage Δ
unittests 96.87% <ø> (ø)

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.

@JoshuaLampert JoshuaLampert marked this pull request as draft February 15, 2025 12:00
@JoshuaLampert JoshuaLampert marked this pull request as ready for review February 15, 2025 13:15
@JoshuaLampert
Copy link
Member Author

JoshuaLampert commented Feb 15, 2025

There is another CI failure due to upstream issues from the OrdinaryDiffEq.jl world. Should be fixed by SciML/OrdinaryDiffEq.jl#2603 and/or SciML/OrdinaryDiffEq.jl#2604.

Copy link
Member

@ranocha ranocha left a comment

Choose a reason for hiding this comment

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

It becomes close to impossible to review this right now since GitHub PRs have degraded performance...

Copy link
Member

@ranocha ranocha 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 enabled auto-merge (squash) February 17, 2025 13:40
@JoshuaLampert
Copy link
Member Author

This will probably need a manual merge since Downgrade will be failing and is required.

@ranocha ranocha merged commit 20dde2b into main Feb 17, 2025
37 of 38 checks passed
@ranocha ranocha deleted the use-ode_default_options branch February 17, 2025 15:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

consistency Make Michael happy

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Use ode_default_options more consistently in the elixirs

3 participants