WayScience / CytoSnake

Orchestrating high-dimensional cell morphology data processing pipelines

https://cytosnake.readthedocs.io

Creative Commons Attribution 4.0 International

3 stars 3 forks source link

Adding testing framework documentation #77

Closed axiomcura closed 1 year ago

axiomcura commented 1 year ago

modified from EmbeddedArtistry

Description

Thank you for your contribution to CytoSnake! Please succinctly summarize your proposed change. What motivated you to make this change?

Please also link to any relevant issues that your code is associated with.

What is the nature of your change?

This PR adds CytoSnake testing framework documentation. A preview of this PR can be viewed here: https://cytosnake-testing-docs.readthedocs.io/en/latest/

Other changes:

added logo to the website (top-left corner)
[ ] Bug fix (fixes an issue).
[ ] Enhancement (adds functionality).
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected).
[X] This change requires a documentation update.

Checklist

Please ensure that all boxes are checked before indicating that a pull request is ready for review.

[X] I have read the CONTRIBUTING.md guidelines.
[X] My code follows the style guidelines of this project.
[X] I have performed a self-review of my own code.
[X] I have commented my code, particularly in hard-to-understand areas.
[X] I have made corresponding changes to the documentation.
[ ] My changes generate no new warnings.
[ ] New and existing unit tests pass locally with my changes.
[ ] I have added tests that prove my fix is effective or that my feature works.
[ ] I have deleted all non-relevant text in this pull request template.

axiomcura commented 1 year ago

Applied all changes! Merging! Thank you all !