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

docs: Update basic usage with better wording for examples. #83

Merged
merged 2 commits into from
Nov 3, 2023

Conversation

nfelt14
Copy link
Collaborator

@nfelt14 nfelt14 commented Nov 2, 2023

Proposed changes

Update the wording in the basic usage document to better indicate how to configure devices.

Types of changes

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

  • 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 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

@nfelt14 nfelt14 requested a review from a team as a code owner November 2, 2023 17:07
@nfelt14 nfelt14 temporarily deployed to package-build November 2, 2023 17:07 — with GitHub Actions Inactive
@nfelt14 nfelt14 added the documentation Improvements or additions to documentation label Nov 2, 2023
@nfelt14 nfelt14 requested a review from a team November 2, 2023 17:08
@nfelt14 nfelt14 enabled auto-merge (squash) November 2, 2023 17:08
Copy link

codecov bot commented Nov 2, 2023

Codecov Report

Merging #83 (5a1f510) into main (a38bd8c) will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##              main       #83   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          168       168           
  Lines         3768      3768           
  Branches       646       646           
=========================================
  Hits          3768      3768           
Files Coverage Δ
.../tm_devices/driver_mixins/class_extension_mixin.py 100.00% <100.00%> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@nfelt14 nfelt14 merged commit bd97781 into main Nov 3, 2023
34 checks passed
@nfelt14 nfelt14 deleted the nfelt14/basic-usage-doc-update branch November 3, 2023 18:36
qthompso pushed a commit to qthompso/tm_devices that referenced this pull request Feb 15, 2024
qthompso pushed a commit to qthompso/tm_devices that referenced this pull request Feb 16, 2024
v12ganesh pushed a commit to v12ganesh/tm_devices that referenced this pull request Mar 28, 2024
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants