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

Audit for frequencies.jl : gyrofrequency and plasma_frequency #16

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

Beforerr
Copy link
Member

  • Item input/output uses Unitful.jl to keep track of units
  • Particle quantities can be specified using ChargedParticles.jl, if applicable
  • Arguments are order independent, or it is documented clearly that this is not the case
  • Output tested against known good examples, either using doctests or in the package tests
  • Output tested against plasmapy, if possible.
  • Docstring with a description of the physical meaning of the quantity, a doctest example, cross references, external references to e.g. Wikipedia, plasmapy, etc.
  • Item is included in the appropriate section of the docs.

@Beforerr
Copy link
Member Author

This CI somehow is tricky. jldoctest in different OS system would give "s⁻¹" or "s^-1".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant