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

Docstrings improvements #40

Open
sleigh2022 opened this issue Oct 16, 2024 · 0 comments
Open

Docstrings improvements #40

sleigh2022 opened this issue Oct 16, 2024 · 0 comments
Assignees
@sleigh2022
Labels
documentation Improvements or additions to documentation

Comments

@sleigh2022
Copy link
Collaborator

Docstrings in some modules, e.g. crm_support, amjuel_support require some cleanup and need to mention some key details when using certain arguments.

One example is the variableECSTransition function and the use of inStates and outStates, which requires the implicit species to be the last item in each list.
@sleigh2022 sleigh2022 added the documentation Improvements or additions to documentation label Oct 16, 2024
@sleigh2022 sleigh2022 self-assigned this Oct 16, 2024
@sleigh2022 sleigh2022 linked a pull request Nov 4, 2024 that will close this issue
Dev sleigh2022 docstrings improvements #41
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sleigh2022 sleigh2022

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Dev sleigh2022 docstrings improvements ukaea/ReMKiT1D-Python
1 participant
@sleigh2022