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.

Sign up for GitHub

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

Jump to bottom

Update our docstrings for PEP 257 #1968

Closed
daspecster opened this issue Jul 8, 2016 · 5 comments
Closed

Update our docstrings for PEP 257 #1968

daspecster opened this issue Jul 8, 2016 · 5 comments
Assignees
@tseaver

Comments

@daspecster
Copy link
Contributor

PyLint has added checks to more closely follow PEP 257 which caused linting to fail. We should update our docstrings so we can revert #1967.
@tseaver
Copy link
Contributor

tseaver commented Jul 11, 2016

Note that pylint 1.6 actually barfs on two of our source files:

  • gcloud/bigtable/happybase/connection.py
  • gcloud/streaming/http_wrapper.py

@tseaver
Copy link
Contributor

tseaver commented Jul 11, 2016

See: pylint-dev/pylint#998

@dhermes
Copy link
Contributor

dhermes commented Jul 18, 2016

I'm digging in to this (hopefully the global disables in #1974 can be addressed easily)

@dhermes dhermes self-assigned this Jul 18, 2016
@dhermes
Copy link
Contributor

dhermes commented Jul 18, 2016

I commented on pylint-dev/pylint#125, which flags our use of grpc.framework.interfaces.face.face.NetworkError with

Catching an exception which doesn't inherit from BaseException: NetworkError (catching-non-exception)

dhermes added a commit to dhermes/google-cloud-python that referenced this issue Jul 18, 2016
@dhermes
PEP257 Clean-up of docstrings.
a76c130 
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.
@dhermes dhermes mentioned this issue Jul 18, 2016
Merged
dhermes added a commit to dhermes/google-cloud-python that referenced this issue Jul 19, 2016
@dhermes
PEP257 Clean-up of docstrings.
a54d078 
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.
@tseaver
Copy link
Contributor

tseaver commented Aug 17, 2016

Via #1996.

@tseaver tseaver closed this as completed Aug 17, 2016
parthea pushed a commit that referenced this issue Sep 22, 2023
@averikitsch @busunkim96
Add Cloud Scheduler sample [(#1968)](GoogleCloudPlatform/python-docs-…
aa0d4ca 
…samples#1968)

* scheduler sample

* scheduler tutorial draft

* create and delete requests completed

* updated region tag

* update error

* fix linting

* Update styling

* Update license

* Update license

* Update license

* Update license
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tseaver tseaver

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@daspecster @tseaver @dhermes