Skip to content

Some refactoring and improvements to docs and comments#50

Merged
emmanuelle merged 7 commits into
mainfrom
dev
Dec 18, 2020
Merged

Some refactoring and improvements to docs and comments#50
emmanuelle merged 7 commits into
mainfrom
dev

Conversation

@almarklein

Copy link
Copy Markdown
Collaborator

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

Copy link
Copy Markdown
Contributor

Merging, thank you @almarklein!

@emmanuelle
emmanuelle merged commit e77d8b3 into main Dec 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants