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

test: enabled doctest in test-docs.yml #22

Merged
merged 2 commits into from
Sep 12, 2024

Conversation

u625355
Copy link
Contributor

@u625355 u625355 commented Sep 12, 2024

Proposed changes

Enabled doctests as part of workflows by enabling it in test-docs.yml

Addresses (#17)

Types of changes

What types of changes does your code introduce?
Put an x in the boxes that apply

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Functionality update (non-breaking change which updates or changes existing functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • CI/CD update (an update to the CI/CD workflows, scripts, and/or configurations)
  • Documentation update (an update to enhance the user experience when reading through the docs)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • I have followed the guidelines in the CONTRIBUTING document
  • I have signed the CLA
  • I have checked to ensure there aren't other open Pull Requests for the same update/change
  • I have created (or updated) an Issue to track the status of this update/change and updated the link in this PR description (see above in the Proposed changes section) using the wording Addresses #<issue_number>
  • I have performed a self-review of my code
  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • Basic linting passes locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have added necessary documentation (if appropriate)
  • I have updated the Changelog with a brief description of my changes

@u625355 u625355 requested a review from a team as a code owner September 12, 2024 16:55
Copy link

codecov bot commented Sep 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.61%. Comparing base (fc1f740) to head (a74521f).
Report is 25 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #22   +/-   ##
=======================================
  Coverage   77.61%   77.61%           
=======================================
  Files           3        3           
  Lines         487      487           
  Branches      106      106           
=======================================
  Hits          378      378           
  Misses         89       89           
  Partials       20       20           

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

@nfelt14
Copy link
Collaborator

nfelt14 commented Sep 12, 2024

@u625355, you will need to rebase your branch.

@u625355 u625355 enabled auto-merge (squash) September 12, 2024 17:04
@nfelt14 nfelt14 disabled auto-merge September 12, 2024 17:05
@nfelt14 nfelt14 enabled auto-merge (squash) September 12, 2024 17:05
Copy link

github-actions bot commented Sep 12, 2024

Test Results (windows)

path passed subtotal
tests\test_client.py 62 62
tests\test_helpers.py 1 1
TOTAL 63 63

Link to workflow run

Copy link

github-actions bot commented Sep 12, 2024

Test Results (macos)

path passed subtotal
tests/test_client.py 62 62
tests/test_helpers.py 1 1
TOTAL 63 63

Link to workflow run

Copy link

github-actions bot commented Sep 12, 2024

Test Results (ubuntu)

path passed subtotal
tests/test_client.py 62 62
tests/test_helpers.py 1 1
TOTAL 63 63

Link to workflow run

@nfelt14 nfelt14 merged commit c71ce0d into tektronix:main Sep 12, 2024
65 checks passed
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.

[BUG]: Enable test_docs.py and doctests tox environment in test-docs.yml workflow
2 participants