Skip to content
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

Testing documentation #1896

Merged
merged 9 commits into from
Nov 17, 2021
Merged

Testing documentation #1896

merged 9 commits into from
Nov 17, 2021

Conversation

albi3ro
Copy link
Contributor

@albi3ro albi3ro commented Nov 15, 2021

This PR adds more information to the Developer Guide's Testing docs.

It also modifies pytest.ini so the tests/beta folder will not be included when running pytest tests. The beta tests can still be explicitly selected and executed.

[sc-11309]

@github-actions
Copy link
Contributor

Hello. You may have forgotten to update the changelog!
Please edit doc/releases/changelog-dev.md with:

  • A one-to-two sentence description of the change. You may include a small working example for new features.
  • A link back to this PR.
  • Your name (or GitHub username) in the contributors section.

@codecov
Copy link

codecov bot commented Nov 15, 2021

Codecov Report

Merging #1896 (62887bc) into master (813c210) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1896   +/-   ##
=======================================
  Coverage   98.90%   98.90%           
=======================================
  Files         219      219           
  Lines       16804    16804           
=======================================
  Hits        16620    16620           
  Misses        184      184           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 813c210...62887bc. Read the comment docs.

@albi3ro albi3ro added the documentation 📘 Documentation changes and updates label Nov 15, 2021
Copy link
Contributor

@antalszava antalszava left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me! 👏 Nice to have these in 🙂

doc/development/guide/tests.rst Outdated Show resolved Hide resolved
doc/development/guide/tests.rst Outdated Show resolved Hide resolved

Or by visiting the `pytest documentation <https://docs.pytest.org/en/latest/reference/reference.html#id88>`__ .

PennyLane provides a set of tests for all PennyLane plugins. See the documentation on these tests under the section on the `device API <https://pennylane.readthedocs.io/en/latest/code/api/pennylane.devices.tests.html>`__.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we could add the example at https://pennylane.readthedocs.io/en/latest/code/api/pennylane.devices.tests.html#the-pl-device-test-cli in this page too?

That could give a rough idea of how the device test suite works and interested readers could then redirect to the other page. Otherwise, I'd think some ppl. might just skip looking there in the first place 😅

Copy link
Contributor

@rmoyard rmoyard left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @albi3ro it looks good to me. 💯 I left a small comment.

doc/development/guide/tests.rst Outdated Show resolved Hide resolved
@albi3ro albi3ro merged commit b2400ce into master Nov 17, 2021
@albi3ro albi3ro deleted the pytest_docs branch November 17, 2021 12:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📘 Documentation changes and updates
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants