JacobBumgarner / VesselVio

An open-source application for the analysis and visualization of segmented vasculature datasets
https://jacobbumgarner.github.io/VesselVio/
GNU General Public License v3.0
100 stars 22 forks source link

Implement unit testing and docstring updates. #31

Open JacobBumgarner opened 2 years ago

JacobBumgarner commented 2 years ago

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:

Backend:

JacobBumgarner commented 2 years ago

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/