Skip to content

PEP257 Clean-up of docstrings. - #1996

Merged
dhermes merged 2 commits into
googleapis:masterfrom
dhermes:partial-revert-1974
Jul 19, 2016
Merged

PEP257 Clean-up of docstrings.#1996
dhermes merged 2 commits into
googleapis:masterfrom
dhermes:partial-revert-1974

Conversation

@dhermes

@dhermesdhermes commented Jul 18, 2016

Copy link
Copy Markdown
Contributor

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.

@googlebotgooglebot added the cla: yes This human has signed the Contributor License Agreement. label Jul 18, 2016
Comment threadgcloud/_helpers.py
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
dhermesforce-pushed the partial-revert-1974 branch from a76c130 to 8ee5e03CompareJuly 19, 2016 18:16
@dhermes

Copy link
Copy Markdown
ContributorAuthor

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

@dhermes

Copy link
Copy Markdown
ContributorAuthor

@tseaver Issues remaining?

@tseaver

Copy link
Copy Markdown
Contributor

LGTM

@dhermes
dhermes merged commit 8f3469c into googleapis:masterJul 19, 2016
@dhermes
dhermes deleted the partial-revert-1974 branch July 19, 2016 21:18
This was referenced Aug 3, 2016
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla: yesThis human has signed the Contributor License Agreement.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@dhermes@tseaver@googlebot