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

add documentation for new 1D plotting functionalities #2280

Merged
merged 3 commits into from
Feb 14, 2025

Conversation

JoshuaLampert
Copy link
Member

This adds some more documentation for the two new features regarding 1D plots implemented in #2250 and #2258 as requested in #2250 (comment).

@JoshuaLampert JoshuaLampert added the documentation Improvements or additions to documentation label Feb 12, 2025
@JoshuaLampert JoshuaLampert requested a review from sloede February 12, 2025 13:24
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.

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.

Thanks a lot!

@sloede sloede enabled auto-merge (squash) February 13, 2025 08:54
@JoshuaLampert JoshuaLampert changed the title Add documentation for new 1D plotting functionalities add documentation for new 1D plotting functionalities Feb 13, 2025
@JoshuaLampert
Copy link
Member Author

Auto-merge doesn't work because the required CI runs don't run. So someone with superpower needs to merge this manually.

@ranocha
Copy link
Member

ranocha commented Feb 13, 2025

The doc build fails since SciML/DiffEqBase.jl#1115 needs to be merged and released. We will wait for it and merge this PR when the Documenter.jl CI job passes.

@ChrisRackauckas
Copy link

Sorry it should come quickly. Long story short, some constructors in SplitFunction referred to that arg as _func_cache while the type name was cache. It's an undocumented argument so we can change it around, but it wasn't an issue until we started using things like Accessors.jl which assume the availability of keyword arguments with the right name. So there were some errors being thrown around in remake for a few months that I isolated to this, but the fix isn't so clean because it involves changing an undocumented name across two repos. But my hope is all tests in SciMLBase/DiffEqBase/OrdinaryDiffEq should be green after this 🤞

@sloede
Copy link
Member

sloede commented Feb 13, 2025

[...] It's an undocumented argument so we can change it around, but it wasn't an issue until we started using things like Accessors.jl [...]

Obligatory xkcd reference:
workflow

Thanks a lot for fixing this 🙏

@JoshuaLampert
Copy link
Member Author

JoshuaLampert commented Feb 13, 2025

DiffEqBase.jl v6.163.0 is out and fixes the problem. Thanks @ChrisRackauckas!

@ranocha ranocha merged commit d9cb5d7 into main Feb 14, 2025
7 checks passed
@ranocha ranocha deleted the document-plotting-1d-function branch February 14, 2025 20:31
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.

4 participants