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

Improve docstring for analysis_particle_indices in MultiStateReporter #676

Merged
merged 5 commits into from Apr 5, 2023

Conversation

ijpulidos
Copy link
Contributor

Description

This improve the documentation of the analysis_particle_indices parameter in MultiStateReporter.

Resolves #641
Resolves #638

It also makes changes for using an up to date version of the sphinx/RTD infrastructure.

Todos

  • Implement feature / fix bug
  • Add tests
  • Update documentation as needed
  • Update changelog to summarize changes in behavior, enhancements, and bugfixes implemented in this PR

Status

  • Ready to go

Changelog message

Improved documentation for ``analysis_particle_indices`` parameter in ``MultiStateReporter``.

@ijpulidos ijpulidos added this to the 0.22.0 milestone Apr 4, 2023
readthedocs.yml Outdated Show resolved Hide resolved
@mikemhenry mikemhenry enabled auto-merge (squash) April 4, 2023 20:05
@mikemhenry mikemhenry merged commit e4616ac into main Apr 5, 2023
14 checks passed
@mikemhenry mikemhenry deleted the 641-fix-docs-multistatereporter branch April 5, 2023 00:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants