Skip to content

Function docstring improvements #223

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

Closed
brandynlucca opened this issue Apr 11, 2024 · 1 comment · Fixed by #297
Closed

Function docstring improvements #223

brandynlucca opened this issue Apr 11, 2024 · 1 comment · Fixed by #297
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@brandynlucca
Copy link
Collaborator

Descriptions for many functions (e.g. calculate_aged_biomass) need to be improved so they include additional information such as the expected data outputs and, in the case of dict and DataFrame objects key column names and variables that are added that will be relevant for other calculations or results the users have generated.

@brandynlucca brandynlucca added the documentation Improvements or additions to documentation label Apr 11, 2024
@brandynlucca brandynlucca self-assigned this Apr 11, 2024
@brandynlucca brandynlucca moved this to In progress in Echopop Jun 22, 2024
@brandynlucca
Copy link
Collaborator Author

Documentation for the user-facing methods (i.e Survey-class methods) are being addressed in #297. While general improvements to docstrings are warranted throughout the library, this will be addressed on a case-by-case basis and will likely be better addressed once many parts of the library have been refactored with new tests (#245 and #263). Therefore, this will be closed once #297 has been merged.

@brandynlucca brandynlucca linked a pull request Nov 8, 2024 that will close this issue
@brandynlucca brandynlucca moved this from In progress to In review in Echopop Nov 8, 2024
@github-project-automation github-project-automation bot moved this from In review to Done in Echopop Nov 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants