Skip to content

Update documentation to reflect refactored changes #335

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
Open
10 tasks
brandynlucca opened this issue Apr 17, 2025 · 0 comments
Open
10 tasks

Update documentation to reflect refactored changes #335

brandynlucca opened this issue Apr 17, 2025 · 0 comments
Assignees
@brandynlucca
Labels
documentation Improvements or additions to documentation refactor tracking_issue
Milestone
Documentation

Comments

@brandynlucca
Copy link
Collaborator

Update the numpydocs docstring and readthedocs documentation for classes, methods, and functions based on the codebase refactoring. This should reflect changes to the following pages:

  • install
  • input_files
  • core_data_structure
  • example_notebooks/example_echopop_workflow
  • example_notebooks/report_generation
  • example_notebooks/plotting
  • example_notebooks/diagnostic_plotting
  • implementation/echopro_vs_echopop
  • implementation/preprocessing_data
  • api
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@brandynlucca brandynlucca

Labels
documentation Improvements or additions to documentation refactor tracking_issue
Projects
Echopop
Status: No status
Milestone
Documentation
Development

No branches or pull requests
1 participant
@brandynlucca