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

Implement unit testing and docstring updates. #31

Open
2 of 27 tasks
JacobBumgarner opened this issue May 15, 2022 · 1 comment
Open
2 of 27 tasks

Implement unit testing and docstring updates. #31

JacobBumgarner opened this issue May 15, 2022 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation maintenance

Comments

@JacobBumgarner
Copy link
Owner

JacobBumgarner commented May 15, 2022

When developing VesselVio, I documented all of the classes and functions with comments. Ideally, I would've used docstrings, but at the time, I wasn't in the know!

Now, to improve the code, I want to convert the comments into docstrings to all of the classes and functions. In addition to this, I want to cover these functions with unit tests to ensure the longevity of the code. This documentation and unit testing will be useful for future Sphinx documentation builds, as suggested in #34.

Docstring Updates and Unit Test Implementations Checklist:
The progress of this task can be tracked in the maint/unit_docstring_update branch!
GUI:

  • analysis_options_widget.py
  • analysis_page.py (in progress)
    • Organization and Docstring Update
    • Unit Testing
  • annotation_page.py
  • graph_options_widget.py
  • left_menu.py
  • movie_widgets.py
  • qt_objects.py
  • stylesheets.py
  • update_alert.py
  • visualization_page.py

Backend:

  • annotation_processing.py
  • feature_extraction.py
  • graph_io.py
  • graph_processing.py
  • helpers.py
  • image_processing.py
  • input_classes.py
  • lee94.py
  • movie_processing.py
  • pk12.py
  • qt_threading.py
  • radii_corrections.py
  • results_export.py
  • volume_processing.py
  • volume_visualization.py
@JacobBumgarner JacobBumgarner self-assigned this May 15, 2022
@JacobBumgarner JacobBumgarner added the documentation Improvements or additions to documentation label May 20, 2022
@JacobBumgarner JacobBumgarner pinned this issue May 20, 2022
@JacobBumgarner JacobBumgarner changed the title Convert comment documentation to docstrings Implement unit testing and docstring updates. May 20, 2022
@JacobBumgarner
Copy link
Owner Author

JacobBumgarner commented May 29, 2022

Just finished up with the annotation_processing.py cleanup update. Fixed a few bugs as well.

This will be addressed in PR #39.

Overview

annotation_processing.py has been converted into:

library/annotation/
- tree_processing.py
- segmentation_prep.py
- segmentation.py
- labeling.py

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 maintenance
Projects
None yet
Development

No branches or pull requests

1 participant