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.

Sign up for GitHub

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

Jump to bottom

Update documentation and add missing dependencies #19

Merged
merged 4 commits into from
Sep 11, 2024
Merged

Update documentation and add missing dependencies #19

merged 4 commits into from
Sep 11, 2024

Conversation

nfelt14
Copy link
Collaborator

@nfelt14 nfelt14 commented Sep 11, 2024 •
edited
Loading

Proposed changes

This adds missing dependencies and updates links in the documentation.

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

@nfelt14 nfelt14 requested review from a team as code owners September 11, 2024 22:38
@codecov Codecov
Copy link

codecov bot commented Sep 11, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.61%. Comparing base (137ff5f) to head (4ca0897).
Report is 29 commits behind head on main.

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

@github-actions GitHub Actions
Copy link

github-actions bot commented Sep 11, 2024 •
edited
Loading

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

@github-actions GitHub Actions
Copy link

github-actions bot commented Sep 11, 2024 •
edited
Loading

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

@github-actions GitHub Actions
Copy link

github-actions bot commented Sep 11, 2024 •
edited
Loading

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

@nfelt14 nfelt14 merged commit c2c720d into main Sep 11, 2024
64 checks passed
@nfelt14 nfelt14 deleted the nfelt14/add-doctests branch September 11, 2024 22:55
u625355
u625355 reviewed Sep 12, 2024
View reviewed changes
Copy link
Contributor

@u625355 u625355 left a comment

Choose a reason for hiding this comment

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

But still package on PyPi is TekHSI. This has to be also updated in package build workflow.

@nfelt14
Copy link
Collaborator Author

nfelt14 commented Sep 12, 2024

But still package on PyPi is TekHSI. This has to be also updated in package build workflow.

Can you put your comment into a file? I don't know where it belongs. The package names on PyPI are case insensitive and also underscores/dashes are interchangeable.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@u625355 u625355 u625355 left review comments

@tekperson tekperson tekperson approved these changes

Assignees

@nfelt14 nfelt14

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@nfelt14 @tekperson @u625355