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

Updated Documentation to include usage of PyVISA and tm_devices along with TekHSI. #24

Merged
merged 12 commits into from
Sep 20, 2024

Conversation

u625355
Copy link
Contributor

@u625355 u625355 commented Sep 19, 2024

Proposed changes

Added example illustrating usage of PyVISA and tm_devices.
Modified data type of a parameter in custom_filter example.

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 19, 2024 17:15
src/tekhsi/tek_hsi_connect.py Fixed Show fixed Hide fixed
src/tekhsi/tek_hsi_connect.py Fixed Show fixed Hide fixed
Copy link

codecov bot commented Sep 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.61%. Comparing base (297aadd) to head (0618757).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #24   +/-   ##
=======================================
  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.

@u625355 u625355 enabled auto-merge (squash) September 19, 2024 17:26
@u625355 u625355 disabled auto-merge September 19, 2024 17:26
@u625355 u625355 requested a review from nfelt14 September 19, 2024 17:27
CHANGELOG.md Outdated Show resolved Hide resolved
docs/requirements.txt Outdated Show resolved Hide resolved
docs/basic_usage.md Show resolved Hide resolved
docs/basic_usage.md Show resolved Hide resolved
@nfelt14 nfelt14 added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 19, 2024
docs/additional_examples_and_pseudo_codes/pyvisa_usage.py Outdated Show resolved Hide resolved
docs/additional_examples_and_pseudo_codes/pyvisa_usage.py Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
@u625355 u625355 requested review from nfelt14 and removed request for nfelt14 September 20, 2024 05:22
@u625355 u625355 requested a review from nfelt14 September 20, 2024 05:22
docs/additional_examples_and_pseudo_code/access_data.py Dismissed Show dismissed Hide dismissed
docs/additional_examples_and_pseudo_code/access_data.py Dismissed Show dismissed Hide dismissed
docs/additional_examples_and_pseudo_code/blocking_methods.py Dismissed Show dismissed Hide dismissed
docs/additional_examples_and_pseudo_code/blocking_methods.py Dismissed Show dismissed Hide dismissed
docs/additional_examples_and_pseudo_code/blocking_methods.py Dismissed Show dismissed Hide dismissed
docs/additional_examples_and_pseudo_code/wait_on_new_data.py Dismissed Show dismissed Hide dismissed
docs/additional_examples_and_pseudo_code/wait_on_next_acq.py Dismissed Show dismissed Hide dismissed
docs/additional_examples_and_pseudo_code/wait_on_time.py Dismissed Show dismissed Hide dismissed
pyproject.toml Outdated Show resolved Hide resolved
docs/requirements.txt Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
@u625355 u625355 requested a review from nfelt14 September 20, 2024 05:57
Copy link

github-actions bot commented Sep 20, 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 20, 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

Copy link

github-actions bot commented Sep 20, 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

@u625355 u625355 merged commit da42f6c into tektronix:main Sep 20, 2024
65 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants