Some refactoring and improvements to docs and comments - Githubissues

plotly / dash-slicer

A volume slicer for Dash

https://dash.plotly.com/slicer

MIT License

24 stars 8 forks source link

Some refactoring and improvements to docs and comments #50

Closed almarklein closed 3 years ago

almarklein commented 3 years ago

Basically I went over the code for some cleanup.

Added more tests. The utils.py was (and is still) fully covered by tests. Everything but the callbacks in slicer.py is also covered.
Moved one big method from slicer.py to utils.py.
Add release procedure to dev notes in readme.
Clarify some docs.
Clarify some comments to help understand the code (also update the ASCII flow chart).

In all, this PR looks pretty big, but is barely has any functional changes.

emmanuelle commented 3 years ago

Merging, thank you @almarklein!