Remove documentation for test_utils.py #252
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ngreenwald
approved these changes
Oct 2, 2020
alex-l-kong
added a commit
that referenced
this pull request
Jan 14, 2021
y2kbugger
pushed a commit
that referenced
this pull request
Jul 29, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is the purpose of this PR?
A very mini-PR to stop generating documentation for
test_utils.py. Addresses and closes #251.How did you implement your changes
We simply modify
conf.pyindocsto ignore every filename containing test in its name, not just those with a test suffix.Remaining issues
If there are any other functions we don't want to generate documentation for, please feel free to let me know and we can address that in this PR too.