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

Set up doctests to catch errors in the examples #126

Open
CPBridge opened this issue Oct 21, 2021 · 1 comment
Open

Set up doctests to catch errors in the examples #126

CPBridge opened this issue Oct 21, 2021 · 1 comment
Assignees
@CPBridge
Labels
documentation Improvements or additions to documentation

Comments

@CPBridge
Copy link
Collaborator

CPBridge commented Oct 21, 2021 •
edited

Various mistakes have been found in the user guide examples. Examples that don't work are very offputting for new users. We should set up automatic testing of the documentation examples to ensure they run correctly.
@CPBridge CPBridge added the documentation Improvements or additions to documentation label Oct 21, 2021
@CPBridge CPBridge self-assigned this Oct 21, 2021
@CPBridge CPBridge mentioned this issue Oct 21, 2021
Merged
shishirpy added a commit to shishirpy/highdicom that referenced this issue Dec 12, 2021
@shishirpy
document examples updated to pass doctests related to ImagingDataComm…
6ba2bbf 
…ons#126
shishirpy added a commit to shishirpy/highdicom that referenced this issue Dec 12, 2021
@shishirpy
examples updated to pass doctests, might need change ImagingDataCommo…
ac675e8 
…ns#126
@CPBridge CPBridge mentioned this issue Apr 2, 2022
Merged
@CPBridge
Copy link
Collaborator Author

CPBridge commented Apr 2, 2022

Doctests has been set up in #165 to catch errors in docstrings.

However this does not catch errors in the RST examples, so leaving this open

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

@CPBridge CPBridge

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@CPBridge