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

Make sure doctest job tests examples in tutorials #542

Merged
merged 17 commits into from
Apr 7, 2024

Conversation

purva-thakre
Copy link
Collaborator

Description

Fixes #179

Changes

  1. This PR adds a line to the docs.yml workflow to make sure we test the examples in .rst files in the documentation. Noticed that make doctest only works on the docstrings of the functions.
  2. Due to 1, doc-examples job is going to fail. Changes were made to some of the .rst files to pass this job.
  3. Index offset for partial_trace and partial_transpose.

Copy link

codecov bot commented Apr 7, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.1%. Comparing base (821602e) to head (beb1322).

Additional details and impacted files
@@          Coverage Diff           @@
##           master    #542   +/-   ##
======================================
  Coverage    98.1%   98.1%           
======================================
  Files         162     162           
  Lines        3112    3112           
  Branches      760     760           
======================================
  Hits         3054    3054           
  Misses         37      37           
  Partials       21      21           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@purva-thakre purva-thakre changed the title Make sure github workflow tests examples in the docs Make sure github workflow tests examples in tutorials Apr 7, 2024
@purva-thakre purva-thakre added this to the v1.0.8 milestone Apr 7, 2024
@purva-thakre purva-thakre marked this pull request as ready for review April 7, 2024 17:14
@purva-thakre purva-thakre changed the title Make sure github workflow tests examples in tutorials Make sure doctest job tests examples in tutorials Apr 7, 2024
Copy link
Owner

@vprusso vprusso left a comment

Choose a reason for hiding this comment

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

LGTM! 🚀

@purva-thakre purva-thakre merged commit 6f15aa1 into master Apr 7, 2024
34 checks passed
@purva-thakre purva-thakre deleted the pytest_tutorials_docs branch April 7, 2024 19:00
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.

Documentation: Update usage of partial trace and partial transpose in tutorial
2 participants