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.

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

PEP257 Clean-up of docstrings. #1996

Merged
merged 2 commits into from
Jul 19, 2016
Merged

Conversation

dhermes
Copy link
Contributor

@dhermes dhermes commented Jul 18, 2016

Fixes all Pylint failures of

  • missing-returns-doc
  • redundant-returns-doc
  • ungrouped-imports

Also makes a little headway on missing-raises-doc though it's unclear if this error should be fixed. Also pylint-dev/pylint@8d35557 makes the bad catching-non-exception go away.

Towards #1968.

@dhermes dhermes added the docs label Jul 18, 2016
@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Jul 18, 2016
@@ -439,8 +441,7 @@ def _to_bytes(value, encoding='ascii'):
:rtype: str / bytes
:returns: The original value converted to bytes (if unicode) or as passed
in if it started out as bytes.
:raises: :class:`TypeError <exceptions.TypeError>` if the value
could not be converted to bytes.
:raises TypeError: if the value could not be converted to bytes.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

Fixes all Pylint failures of
- missing-returns-doc
- redundant-returns-doc
- ungrouped-imports

Also makes a little headway on missing-raises-doc though it's
unclear if this error should be fixed.

Towards googleapis#1968.
This is because the false positive was fixed in Pylint
1.6.4.
@dhermes
Copy link
Contributor Author

dhermes commented Jul 19, 2016

@tseaver FYI I added another commit since pylint 1.6.4 fixed a false positive.

@dhermes
Copy link
Contributor Author

dhermes commented Jul 19, 2016

@tseaver Issues remaining?

@tseaver
Copy link
Contributor

tseaver commented Jul 19, 2016

LGTM

@dhermes dhermes merged commit 8f3469c into googleapis:master Jul 19, 2016
@dhermes dhermes deleted the partial-revert-1974 branch July 19, 2016 21:18
This was referenced Aug 3, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes This human has signed the Contributor License Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants