Thank you for submitting this pull request (PR)! ✨

Below are checks that are being run for this PR. Click on the name of a check to learn why it didn't pass. ✅ Don't worry if something broke! We break stuff all the time. 😅

PlasmaPy's contributor guide has pages on:

• 🌱 Getting ready to contribute
• 🔧 Code contribution workflow
• 📜 Changelog entries
• 💻 Coding tips and guidelines
• 📚 Documentation
• 🧪 Tests

We thank you once again! 🌌

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.59%. Comparing base (d3bca28) to head (6b2ea23).

@@           Coverage Diff           @@
##             main    #3217   +/-   ##
=======================================
  Coverage   94.59%   94.59%           
=======================================
  Files         108      108           
  Lines        9872     9873    +1     
  Branches     1501     1501           
=======================================
+ Hits         9338     9339    +1     
  Misses        332      332           
  Partials      202      202           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Thank you for submitting this!

In this case, Z was being used by a decorator to ion_sound_speed, so this change isn't needed.

In ion_sound_speed and many other formulary functions, the Z parameter is used by @particle_input to create the Particle object. An example of how it's used is:

>>> from plasmapy.particles import particle_input, ParticleLike, Particle
>>>
>>> @particle_input
... def transform_into_particle(particle: ParticleLike, Z=None) -> Particle:
...     return particle
...     
>>> transform_into_particle("He", Z=2)
Particle("He 2+")

This pattern is less explicit, but decorators help us avoid having to repeat code that used in a lot of different functions.

Thank you for submitting this!

In this case, Z was being used by a decorator to ion_sound_speed, so this change isn't needed.

In ion_sound_speed and many other formulary functions, the Z parameter is used by @particle_input to create the Particle object. An example of how it's used is:

>>> from plasmapy.particles import particle_input, ParticleLike, Particle
>>>
>>> @particle_input
... def transform_into_particle(particle: ParticleLike, Z=None) -> Particle:
...     return particle
...     
>>> transform_into_particle("He", Z=2)
Particle("He 2+")

This pattern is less explicit, but decorators help us avoid having to repeat code that used in a lot of different functions.

Thanks @namurphy for the clarification — that makes sense now.

I really appreciate this design pattern; it's a clean way to avoid repeating logic across functions. Thanks for the review, and sorry for the unnecessary trouble!