Sphinx and PEP8 docstring fix #206

dhermes · 2014-10-01T23:59:29Z

Fixes too long (PEP8) single-line docstring descriptions. Fixes some Sphinx errors and warnings as well as bad links.

dhermes · 2014-10-02T00:00:30Z

The type gcloud.datastore.datastore_v1_pb2.Query described in datastore.query.Query.to_protobuf doesn't seem to exist? At the very least, Sphinx fails to link it.

@tseaver Do you know how this works?

dhermes · 2014-10-02T00:02:41Z

This is part of the ongoing work towards #179

dhermes · 2014-10-02T00:09:07Z

I think adding the -n nit-picky flag and -W "Turn warnings into errors" flag would be a way to satisfy #178 and likely would be worth doing for continued docs quality.

tseaver · 2014-10-02T03:37:57Z

The type gcloud.datastore.datastore_v1_pb2.Query described in
datastore.query.Query.to_protobuf doesn't seem to exist? At the very
least, Sphinx fails to link it.

Hmm, it imports fine as long as the 'gcloud-python' distribution is on
PYTHONPATH:

$ ../../bin/python
Python 2.7.6 (default, Nov 15 2013, 11:35:43) 
[GCC 4.6.3] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> from gcloud.datastore.datastore_v1_pb2 import Query
>>> Query
<class 'gcloud.datastore.datastore_v1_pb2.Query'>

How are you provoking the error in Sphinx? This works for me:

$ rm -r docs/_build
$ tox -e docs
GLOB sdist-make: /home/tseaver/projects/agendaless/Google/src/gcloud-python/setup.py
docs inst-nodeps: /home/tseaver/projects/agendaless/Google/src/gcloud-python/.tox/dist/gcloud-0.02.2.zip
docs runtests: PYTHONHASHSEED='1286245116'
docs runtests: commands[0] | sphinx-build -b html -d docs/_build/doctrees docs docs/_build/html
Making output directory...
Running Sphinx v1.2.3
loading pickled environment... not yet created
building [html]: targets for 9 source files that are out of date
updating environment: 9 added, 0 changed, 0 removed
reading sources... [100%] storage-quickstart                                    
/home/tseaver/projects/agendaless/Google/src/gcloud-python/docs/index.rst:17: WARNING: Duplicate explicit target name: "official documentation".
/home/tseaver/projects/agendaless/Google/src/gcloud-python/docs/index.rst:17: WARNING: Duplicate explicit target name: "official documentation".
/home/tseaver/projects/agendaless/Google/src/gcloud-python/docs/index.rst:17: WARNING: Duplicate explicit target name: "official documentation".
/home/tseaver/projects/agendaless/Google/src/gcloud-python/docs/index.rst:17: WARNING: Duplicate explicit target name: "official documentation".
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] storage-quickstart                                     
writing additional files... (17 module code pages) _modules/index genindex py-modindex search
copying images... [100%] _static/bigquery-logo.png                              
copying static files... done
copying extra files... done
dumping search index... done
dumping object inventory... done
build succeeded, 4 warnings.
___________________________________ summary ____________________________________
docs: commands succeeded
congratulations :)

dhermes · 2014-10-02T06:46:08Z

@tseaver I don't know how I missed the class definition on my first scan of the file.

I realize now that the type exists, but doesn't show up as a link because the module isn't included in the relevant module list for the datastore package.

I didn't notice this from an error thrown by Sphinx, but rather by a doc scan of datastore-api.html after some changes I made in this PR.

Sphinx and PEP8 docstring fix

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>

Source-Link: googleapis/synthtool@c4dd595 Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:ce3c1686bc81145c81dd269bd12c4025c6b275b22d14641358827334fddb1d72 Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

Source-Link: googleapis/synthtool@453a5d9 Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:81ed5ecdfc7cac5b699ba4537376f3563f6f04122c4ec9e735d3b3dc1d43dd32

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>

Source-Link: googleapis/synthtool@d2871d9 Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:b2dc5f80edcf5d4486c39068c9fa11f7f851d9568eea4dcba130f994ea9b5e97 Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

Source-Link: https://togithub.com/googleapis/synthtool/commit/92006bb3cdc84677aa93c7f5235424ec2b157146 Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:2e247c7bf5154df7f98cce087a20ca7605e236340c7d6d1a14447e5c06791bd6

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>

Source-Link: https://togithub.com/googleapis/synthtool/commit/5f2a6089f73abf06238fe4310f6a14d6f6d1eed3 Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:8555f0e37e6261408f792bfd6635102d2da5ad73f8f09bcb24f25e6afb5fac97

…206) Source-Link: googleapis/synthtool@8e55b32 Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:c6c965a4bf40c19011b11f87dbc801a66d3a23fbc6704102be064ef31c51f1c3

* feat: Add support for python 3.11 chore: Update gapic-generator-python to v1.8.0 PiperOrigin-RevId: 500768693 Source-Link: googleapis/googleapis@190b612 Source-Link: googleapis/googleapis-gen@7bf29a4 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiN2JmMjlhNDE0YjllY2FjMzE3MGYwYjY1YmRjMmE5NTcwNWMwZWYxYSJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

Source-Link: googleapis/synthtool@52e4e46 Post-Processor: gcr.io/repo-automation-bots/owlbot-python:latest@sha256:6186535cbdbf6b9fe61f00294929221d060634dae4a0795c1cefdbc995b2d605

🤖 I have created a release \*beep\* \*boop\* --- ### [3.3.2](https://www.github.com/googleapis/python-translate/compare/v3.3.1...v3.3.2) (2021-07-29) ### Bug Fixes * enable self signed jwt for grpc ([#215](https://www.github.com/googleapis/python-translate/issues/215)) ([2f1bc32](https://www.github.com/googleapis/python-translate/commit/2f1bc327fd436f2f7e86c676cbbf1e7d7cc61921)) ### Documentation * add Samples section to CONTRIBUTING.rst ([#206](https://www.github.com/googleapis/python-translate/issues/206)) ([6f1df67](https://www.github.com/googleapis/python-translate/commit/6f1df6794394bcbedb18199793aaebb9c095ccf5)) ### Miscellaneous Chores * release as 3.3.2 ([#218](https://www.github.com/googleapis/python-translate/issues/218)) ([e14de99](https://www.github.com/googleapis/python-translate/commit/e14de99d9d3480274ba92ef36c93f0b626a2bd91)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

Source-Link: googleapis/synthtool@dd05f9d Post-Processor: gcr.io/repo-automation-bots/owlbot-python:latest@sha256:aea14a583128771ae8aefa364e1652f3c56070168ef31beb203534222d842b8b

Source-Link: googleapis/synthtool@06e8279 Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:b3500c053313dc34e07b1632ba9e4e589f4f77036a7cf39e1fe8906811ae0fce

* chore: Update gapic-generator-python to v1.8.5 PiperOrigin-RevId: 511892190 Source-Link: googleapis/googleapis@a45d9c0 Source-Link: googleapis/googleapis-gen@1907294 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMTkwNzI5NGIxZDgzNjVlYTI0ZjhjNWYyZTA1OWE2NDEyNGM0ZWQzYiJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: Anthonios Partheniou <[email protected]>

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>

Source-Link: googleapis/synthtool@703554a Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:94961fdc5c9ca6d13530a6a414a49d2f607203168215d074cdb0a1df9ec31c0b

Source-Link: https://togithub.com/googleapis/synthtool/commit/909573ce9da2819eeb835909c795d29aea5c724e Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:ddf4551385d566771dc713090feb7b4c1164fb8a698fe52bbe7670b24236565b

Source-Link: googleapis/synthtool@06e8279 Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:b3500c053313dc34e07b1632ba9e4e589f4f77036a7cf39e1fe8906811ae0fce

…206) Source-Link: https://togithub.com/googleapis/synthtool/commit/26358881238150aa51939ccc82b78c0e33d3bc9c Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:007e7e46ef05e5a32e652bd0062be02f6ff050347d91e0f357b28caab0a042c4

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>

Post-Processor: gcr.io/repo-automation-bots/owlbot-python:latest@sha256:c66ba3c8d7bc8566f47df841f98cd0097b28fff0b1864c86f5817f4c8c3e8600

Adds details about blacken, updates version for system tests, and shows how to pass through pytest arguments. Source-Author: Chris Cotter <[email protected]> Source-Date: Mon Feb 8 17:13:36 2021 -0500 Source-Repo: googleapis/synthtool Source-Sha: 4679e7e415221f03ff2a71e3ffad75b9ec41d87e Source-Link: googleapis/synthtool@4679e7e

Also, fix 2.7 tests broken by release of 'googleapis-common-protos 1.53.0', which dropped Python 2.7 support. Closes #169

* chore: release 0.10.0 * Improved change entry, Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com> Co-authored-by: Jim Fulton <[email protected]>

Closes #206.

Due to an upstream change in how a module was imported and referenced, we needed to update some of our compliance tests to match. Fixes #200 🦕 Fixes #201 🦕 Fixes #202 🦕 Fixes #203 🦕 Fixes #204 🦕 Fixes #205 🦕 Fixes #206 🦕 Fixes #207 🦕

Source-Link: googleapis/synthtool@0ddbff8 Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:bced5ca77c4dda0fd2f5d845d4035fc3c5d3d6b81f245246a36aee114970082b Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

* Add 'AnonymousCredentials' class. See: #4279. * Nits * Fix whitespace

beriberikix added the in progress label Oct 1, 2014

dhermes added the hygiene label Oct 2, 2014

dhermes mentioned this pull request Oct 2, 2014

Fixed a majority of pep8 errors in gcloud. #200

Merged

dhermes added 2 commits October 2, 2014 11:17

Resolving all sphinx warnings and parse errors.

0b4aa56

Fixing remaining PEP8 long line issues.

39101ae

dhermes force-pushed the tox-docstring-fix branch from b4bf54f to 39101ae Compare October 2, 2014 18:48

silvolu added a commit that referenced this pull request Oct 2, 2014

Merge pull request #206 from dhermes/tox-docstring-fix

f898953

Sphinx and PEP8 docstring fix

silvolu merged commit f898953 into googleapis:master Oct 2, 2014

beriberikix removed the in progress label Oct 2, 2014

dhermes deleted the tox-docstring-fix branch October 2, 2014 19:55

dhermes mentioned this pull request Oct 21, 2014

Fixing Sphinx warnings and preventing more from occurring. #277

Merged

urshala pushed a commit to urshala/google-cloud-python that referenced this pull request Jan 17, 2020

Fix googleapis#206

e906938

parthea pushed a commit that referenced this pull request May 31, 2023

chore(main): release 0.9.0 (#206)

041449f

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>

parthea pushed a commit that referenced this pull request Jun 4, 2023

chore(main): release 0.10.1 (#206)

de2b926

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>

parthea pushed a commit that referenced this pull request Jun 4, 2023

chore(main): release 1.7.0 (#206)

ea147d0

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>

parthea pushed a commit that referenced this pull request Oct 21, 2023

chore(deps): update dependency google-analytics-data to v0.11.1 (#206)

fae01c4

parthea pushed a commit that referenced this pull request Oct 21, 2023

chore: update doc links from googleapis.dev to cloud.google.com (#206)

51be6c6

parthea pushed a commit that referenced this pull request Oct 22, 2023

chore(main): release 1.5.2 (#206)

d2eeb30

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>

parthea pushed a commit that referenced this pull request Jan 10, 2025

chore(main): release 1.8.0 (#206)

cb0d40a

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>

parthea pushed a commit that referenced this pull request Aug 21, 2025

chore: new owl bot post processor docker image (#206)

8b7b221

Post-Processor: gcr.io/repo-automation-bots/owlbot-python:latest@sha256:c66ba3c8d7bc8566f47df841f98cd0097b28fff0b1864c86f5817f4c8c3e8600

parthea pushed a commit that referenced this pull request Sep 16, 2025

chore: new owl bot post processor docker image (#206)

49f6077

Post-Processor: gcr.io/repo-automation-bots/owlbot-python:latest@sha256:c66ba3c8d7bc8566f47df841f98cd0097b28fff0b1864c86f5817f4c8c3e8600

parthea pushed a commit that referenced this pull request Nov 24, 2025

Fix map field (#206)

6762647

parthea added a commit that referenced this pull request Nov 24, 2025

chore: test minimum dependencies in python 3.7 (#206)

17f8985

parthea pushed a commit that referenced this pull request Nov 24, 2025

chore: remove the circleci badge (#206)

cb5ed11

parthea pushed a commit that referenced this pull request Nov 24, 2025

chore: blacken (#206)

daaeff2

Also, fix 2.7 tests broken by release of 'googleapis-common-protos 1.53.0', which dropped Python 2.7 support. Closes #169

parthea pushed a commit that referenced this pull request Nov 24, 2025

tests: allow prerelease deps on Python 3.9 (#207)

a0adcc3

Closes #206.

parthea pushed a commit that referenced this pull request Nov 24, 2025

test: install pyopenssl for mtls testing (#206)

52d156a

parthea pushed a commit that referenced this pull request Nov 24, 2025

Update intersphinx mapping (#206)

7027ff2

parthea pushed a commit that referenced this pull request Nov 25, 2025

test: install pyopenssl for mtls testing (#206)

c962e2f

parthea pushed a commit that referenced this pull request Nov 26, 2025

Add 'AnonymousCredentials' class. (#206)

9756b32

* Add 'AnonymousCredentials' class. See: #4279. * Nits * Fix whitespace

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Sphinx and PEP8 docstring fix #206

Sphinx and PEP8 docstring fix #206

Uh oh!

dhermes commented Oct 1, 2014

Uh oh!

dhermes commented Oct 2, 2014

Uh oh!

dhermes commented Oct 2, 2014

Uh oh!

dhermes commented Oct 2, 2014

Uh oh!

tseaver commented Oct 2, 2014

Uh oh!

dhermes commented Oct 2, 2014

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Sphinx and PEP8 docstring fix #206

Sphinx and PEP8 docstring fix #206

Uh oh!

Conversation

dhermes commented Oct 1, 2014

Uh oh!

dhermes commented Oct 2, 2014

Uh oh!

dhermes commented Oct 2, 2014

Uh oh!

dhermes commented Oct 2, 2014

Uh oh!

tseaver commented Oct 2, 2014

Uh oh!

dhermes commented Oct 2, 2014

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants