-
Notifications
You must be signed in to change notification settings - Fork 3
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
Adding testing framework documentation #77
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks great @axiomcura !
I made several in-line suggestions, mostly aiming to improve clarity and consistency. I also had some comments on small improvements to the figures. Also, the figures are not rendering in the testing rtd (but maybe this is expected until after merge)
Is the strategy to add the remaining unittest and workflow test documentation as you actually add their implementation alongside?
No need for me to re-review prior to your merging, but please don't hesitate to ask any questions.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice work! Overall I thought things looked good and left a few comments for your consideration. Please don't hesitate to let me know if you have any questions.
Note: I wasn't able to see the preview at https://cytosnake-testing-docs.readthedocs.io/en/latest/ (the link appears to result in a 404).
tests/README-tests.md
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is beautifully written, great job!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This comment is in regards to the filenames of this and the other similar README-*.md
files within the docs/tests
dir: do these files require README
in the name? If they don't, consider defaulting to a filename without README-
. In seeing the other files which reference these outside the docs/tests
directory, consider moving the content there.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider removing this image if it isn't required (it looks like the svg is referenced instead).
Co-authored-by: Dave Bunten <ekgto445@gmail.com>
Co-authored-by: Dave Bunten <ekgto445@gmail.com>
Co-authored-by: Dave Bunten <ekgto445@gmail.com>
Applied all changes! Merging! Thank you all ! |
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).
This change requires a documentation update.
Checklist
Please ensure that all boxes are checked before indicating that a pull request is ready for review.