Thank you for contributing to PlasmaPy! The project's future depends deeply on contributors like you, so we deeply appreciate it! 🌱 The following checklist will be used by the code reviewer to help guide the code review process.

• Overall
  • Does the PR do what it intends to do?
  • Except for very minor changes, is a changelog entry included and consistent with the changelog guide?
  • Are the continuous integration checks passing? (Most linter problems can be automagically fixed by commenting on this PR with pre-commit.ci autofix.)
• Code
  • Is new/updated code understandable and consistent with the coding guide?
  • Are there ways to greatly simplify the implementation?
  • Are there any large functions that should be split up into shorter functions?
• Tests
  • Are tests added/updated as required, and consistent with the testing guide?
  • Are the tests understandable?
  • Do the tests cover all important cases?
• Docs
  • Are docs added/updated as required, and consistent with the doc guide?
  • Are the docs understandable?
  • Do the docs show up correctly in the preview, including Jupyter notebooks?

Codecov Report

Base: 98.31% // Head: 98.31% // No change to project coverage 👍

Coverage data is based on head (669bdf8) compared to base (a970130).
Patch has no changes to coverable lines.

❗ Current head 669bdf8 differs from pull request most recent head bb01910. Consider uploading reports for the commit bb01910 to get more accurate results

@@           Coverage Diff           @@
##             main    #1863   +/-   ##
=======================================
  Coverage   98.31%   98.31%           
=======================================
  Files          95       95           
  Lines        8372     8372           
=======================================
  Hits         8231     8231           
  Misses        141      141           

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

pre-commit.ci autofix

The pre-commit failure appears to be upstream of pretty-format-toml, but there's an issue for it and it looks like it's being worked on. It requires This seems to be one of those errors that'll get fixed if we don't do anything (thank you upstream maintainers!), so my inclination is to wait to do anything unless it starts to hold up PRs, in which case we can temporarily turn off pretty-format-toml.