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.

Sign up for GitHub

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

Jump to bottom

Expand documentation for ionization state classes #577

Closed
4 tasks
namurphy opened this issue Oct 31, 2018 · 2 comments
Closed
4 tasks

Expand documentation for ionization state classes #577

namurphy opened this issue Oct 31, 2018 · 2 comments
Assignees
@namurphy
Labels
docs PlasmaPy Docs at http://docs.plasmapy.org plasmapy.particles Related to the plasmapy.particles subpackage priority: high Issues & PRs with significant urgency and importance that should be addressed soon
Projects
PlasmaPy 0.2.0 Documentation Development
Milestone
v0.3.0

Comments

@namurphy
Copy link
Member

The IonizationState and IonizationStates classes were created in #404 to represent what fraction of an element's population was in what ionization level. The docstrings for these classes are not yet sufficient, and in particular do not talk about the effects of the different dunder methods, like __iter__/__next__, __getitem__, and __setitem__. Additionally, narrative documentation has not been written for any of this. The remaining steps will be to:

  • Expand docstring of IonizationState
  • Write narrative documentation for IonizationState
  • Expand docstring of IonizationStates
  • Write narrative documentation for IonizationStates
@namurphy namurphy added plasmapy.particles Related to the plasmapy.particles subpackage docs PlasmaPy Docs at http://docs.plasmapy.org labels Oct 31, 2018
@namurphy namurphy added this to the v0.2.0 milestone Oct 31, 2018
@namurphy namurphy added this to To do in PlasmaPy 0.2.0 via automation Oct 31, 2018
@namurphy namurphy added the priority: high Issues & PRs with significant urgency and importance that should be addressed soon label Oct 31, 2018
@namurphy namurphy self-assigned this Apr 30, 2019
@StanczakDominik
Copy link
Member

Let's revisit this for 0.3.0 😃

@StanczakDominik StanczakDominik modified the milestones: v0.2.0, v0.3.0 May 30, 2019
@StanczakDominik
Copy link
Member

@namurphy I think this just about got done a while ago, no? :)

Documentation Development automation moved this from Backlog to Closed / Cancelled Mar 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@namurphy namurphy

Labels
docs PlasmaPy Docs at http://docs.plasmapy.org plasmapy.particles Related to the plasmapy.particles subpackage priority: high Issues & PRs with significant urgency and importance that should be addressed soon
Projects
Documentation Development
  
Closed / Cancelled
PlasmaPy 0.2.0
  
To do
Milestone
v0.3.0
Development

No branches or pull requests
2 participants
@namurphy @StanczakDominik