-
Notifications
You must be signed in to change notification settings - Fork 127
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 unit testing section #1621
Conversation
Please add one of the following labels to add this contribution to the Release Notes 👇 |
Codecov Report
@@ Coverage Diff @@
## main #1621 +/- ##
==========================================
- Coverage 82.84% 82.74% -0.10%
==========================================
Files 44 44
Lines 7151 7151
==========================================
- Hits 5924 5917 -7
- Misses 1227 1234 +7 |
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.
It's looking good. Can't add more than @germa89's comments =)
Co-authored-by: German <[email protected]> Co-authored-by: Roberto Pastor Muela <[email protected]>
….com/pyansys/pymapdl into doc/adding-unit-testing-informations
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.
LGTM in general! Some minor comments. Leaving final review to @germa89 (since he is the PyMAPDL boss =P)
Co-authored-by: Roberto Pastor Muela <[email protected]>
Co-authored-by: Roberto Pastor Muela <[email protected]>
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.
Hi Camile
I have left some comments in the PR, most of them are grammar based. Others are based on the following suggestions:
- Add all the links to
links.rst
and then reference it from there as explained in Addinglinks.rst
to docs #1506 - Explain a bit more about how to couple your tests with the existing ones. i.e. explain what are fixtures.
- Reference any document, text, image, or whatever thing you do copy from somewhere else.
With the proposed changes, you will have to add these links to links.rst
:
.. _pytest: pytest.org
.. _pymapdl_tests: https://github.com/pyansys/pymapdl/tree/main/tests
.. _codecov: https://github.com/codecov
.. _pytest_usage: https://docs.pytest.org/en/7.2.x/how-to/usage.html#specifying-which-tests-to-run
.. _article_good_unit_test: https://stackoverflow.com/questions/61400/what-makes-a-good-unit-test
.. _mapdl_fixture: https://github.com/pyansys/pymapdl/blob/fb5fb8b6201253f1bd56bdabee60a29abee8c7d8/tests/conftest.py#L254
.. _pymapdl_test_math: https://github.com/pyansys/pymapdl/blob/main/tests/test_math.py
.. _pymapdl_user_guide_math: https://mapdl.docs.pyansys.com/user_guide/math.html
Pinging @maromer0 for learning purposes. Please Manu have a look at this PR and start to get familiarized with how the documentation is written using RST. |
Co-authored-by: German <[email protected]>
Co-authored-by: German <[email protected]>
Co-authored-by: Kathy Pippert <[email protected]>
Co-authored-by: Kathy Pippert <[email protected]>
Co-authored-by: Kathy Pippert <[email protected]>
@germa89 you have to approve so that we can merge =) |
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.
LGTM.
Closes #1536