cleaning up attrs/mypy workaround comments to remove them from rendered docs #51
Conversation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description of changes:
I realized that the note about the attrs/mypy workaround added in #44 showed up in the rendered docs. This is not what we want, so this changes all of those into comments (rather than docstrings) and disables that flake8 docstring check on those methods (
noqa=D107).There are also a few minor fixes identified by pylint in
most_recent.py, setting initial values for_versionand_last_updatedas well as simplifying a value check.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.