docs: fix or ignore missing docstrings #205
Open
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
The httbin.org service returns a X-Amzn-Trace-Id header in its responses, which is different for each request. This causes the tests to fail. This clears the header before comparing responses. Refs: betamaxpy#184, betamaxpy#190 Signed-off-by: Jaremy Hatler <[email protected]>
The betamax directory was moved into the src directory but the tox workflow was not updated to reflect this change. This commit updates the tox workflow to use the new path. Refs: betamaxpy#203, cf6aefe Signed-off-by: Jaremy Hatler <[email protected]>
This updates the docstrings, where trivial, to pass the flake8 docstring checks. In the cases where adding docstrings was non-trivial, the docstring check was ignored. Refs: betamaxpy#204 Signed-off-by: Jaremy Hatler <[email protected]>
jhatler
force-pushed
the
fix/docstringReview
branch
from
fa7d128
to
e9c2a2a
Compare
|
I don't have the necessary knowledge (or time) to provide docstrings for the entire codebase. I made the trivial changes that I could so the flake8-docstring checks pass. This is verified in jhatler#4. |
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.
This updates the docstrings, where trivial, to pass the flake8 docstring checks. In the cases where adding docstrings was non-trivial, the docstring check was ignored.
Refs: #204
Signed-off-by: Jaremy Hatler [email protected]