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

[FEAT]: Add examples to docstrings and enable pytest --doctest-modules in tox config #16

Closed
nfelt14 opened this issue Sep 11, 2024 · 1 comment
Closed

[FEAT]: Add examples to docstrings and enable pytest --doctest-modules in tox config #16

nfelt14 opened this issue Sep 11, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@nfelt14
Copy link
Collaborator

nfelt14 commented Sep 11, 2024

Description

It would be nice if the docstrings had examples. These examples should then be tested using pytest. The tox config has a line that will perform testing, but it is currently commented out.

Additional Information

No response
@nfelt14 nfelt14 added the enhancement New feature or request label Sep 11, 2024
@nfelt14
Copy link
Collaborator Author

nfelt14 commented Oct 1, 2024

Because of the necessary connections to use TekHSI, these examples don't work during a pytest run.

@nfelt14 nfelt14 closed this as completed Oct 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@nfelt14