Skip to content

Improve autodocs for top-level package names. - #882

Merged
tseaver merged 2 commits into
googleapis:masterfrom
tseaver:845-document__implicit_environ
May 18, 2015
Merged

Improve autodocs for top-level package names.#882
tseaver merged 2 commits into
googleapis:masterfrom
tseaver:845-document__implicit_environ

Conversation

@tseaver

Copy link
Copy Markdown
Contributor
  • Drop the __init__ from them.
  • Include the ones imported from _implicit_environ'

Fixes#845.

- Drop the '__init__' from them.
- Include the ones imported from '_implicit_environ'.
Fixes#845.
@tseavertseaver added api: datastore Issues related to the Datastore API. docs api: storage Issues related to the Cloud Storage API. api: pubsub Issues related to the Pub/Sub API. labels May 14, 2015
@googlebotgooglebot added the cla: yes This human has signed the Contributor License Agreement. label May 14, 2015
@coveralls

Copy link
Copy Markdown

Coverage Status

Coverage remained the same at 100.0% when pulling 22e4c63 on tseaver:845-document__implicit_environ into 9c4867a on GoogleCloudPlatform:master.

@dhermes

Copy link
Copy Markdown
Contributor

I've checked out this branch and built the docs. All looks good, can you fix the docstring for datastore.set_defaults so the bullets render correctly? Use * instead of - for Sphinx.

@dhermes

Copy link
Copy Markdown
Contributor

Also a concern, this is very manual. How will we make sure new methods in __init__ get added to the docs?

@tseaver

Copy link
Copy Markdown
ContributorAuthor

fbba1c4 fixes the bullet rendering (not *, but a leading blank line, was required).

WRT manual config: We can't have best of all worlds for members imported into the base package:

  • Adding :imported-members: would pick up all the imports.
  • Adding just the ones we want to __all__ would make using the others look unsupported.

The real fix would be to move those implementations into the base package, and have them just tweak the defaults object in _implicit_environ.

@coveralls

Copy link
Copy Markdown

Coverage Status

Coverage remained the same at 100.0% when pulling fbba1c4 on tseaver:845-document__implicit_environ into 9c4867a on GoogleCloudPlatform:master.

@dhermes

Copy link
Copy Markdown
Contributor

I don't think the circular import gymnastics is worth it for this somewhat minor nit. Proceed: LGTM.

tseaver added a commit that referenced this pull request May 18, 2015
Improve autodocs for top-level package names.
@tseaver
tseaver merged commit 6bc4e02 into googleapis:masterMay 18, 2015
@tseaver
tseaver deleted the 845-document__implicit_environ branch May 18, 2015 18:45
@dhermesdhermes mentioned this pull request Jun 4, 2015
parthea pushed a commit that referenced this pull request Sep 18, 2025
Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
parthea pushed a commit that referenced this pull request Nov 22, 2025
* feat: add new v3.0.0 API skeleton (#745)
* feat: improve rows filters (#751)
* feat: read rows query model class (#752)
* feat: implement row and cell model classes (#753)
* feat: add pooled grpc transport (#748)
* feat: implement read_rows (#762)
* feat: implement mutate rows (#769)
* feat: literal value filter (#767)
* feat: row_exists and read_row (#778)
* feat: read_modify_write and check_and_mutate_row (#780)
* feat: sharded read rows (#766)
* feat: ping and warm with metadata (#810)
* feat: mutate rows batching (#770)
* chore: restructure module paths (#816)
* feat: improve timeout structure (#819)
* fix: api errors apply to all bulk mutations
* chore: reduce public api surface (#820)
* feat: improve error group tracebacks on < py11 (#825)
* feat: optimize read_rows (#852)
* chore: add user agent suffix (#842)
* feat: optimize retries (#854)
* feat: add test proxy (#836)
* chore(tests): add conformance tests to CI for v3 (#870)
* chore(tests): turn off fast fail for conformance tets (#882)
* feat: add TABLE_DEFAULTS enum for table method arguments (#880)
* fix: pass None for retry in gapic calls (#881)
* feat: replace internal dictionaries with protos in gapic calls (#875)
* chore: optimize gapic calls (#863)
* feat: expose retryable error codes to users (#879)
* chore: update api_core submodule (#897)
* chore: merge main into experimental_v3 (#900)
* chore: pin conformance tests to v0.0.2 (#903)
* fix: bulk mutation eventual success (#909)
---------
Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
parthea added a commit that referenced this pull request Nov 24, 2025
* chore(python): bump idna from 3.4 to 3.7 in .kokoro
Source-Link: googleapis/synthtool@d50980e
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:5a4c19d17e597b92d786e569be101e636c9c2817731f80a5adec56b2aa8fe070
* Apply changes from googleapis/synthtool#1950
* 🦉 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 <partheniou@google.com>
parthea pushed a commit that referenced this pull request Nov 24, 2025
parthea added a commit that referenced this pull request Nov 25, 2025
* chore(python): bump idna from 3.4 to 3.7 in .kokoro
Source-Link: googleapis/synthtool@d50980e
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:5a4c19d17e597b92d786e569be101e636c9c2817731f80a5adec56b2aa8fe070
* Apply changes from googleapis/synthtool#1950
* 🦉 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 <partheniou@google.com>
parthea pushed a commit that referenced this pull request Nov 26, 2025
parthea pushed a commit that referenced this pull request Feb 13, 2026
Mypy tests are are currently failing, due to a combination of a typing
change in the auth library, and the deprecation of Python 3.7
This PR fixes mypy, and makes the types a bit more explicit
parthea pushed a commit that referenced this pull request Mar 2, 2026
* feat: add new v3.0.0 API skeleton (#745)
* feat: improve rows filters (#751)
* feat: read rows query model class (#752)
* feat: implement row and cell model classes (#753)
* feat: add pooled grpc transport (#748)
* feat: implement read_rows (#762)
* feat: implement mutate rows (#769)
* feat: literal value filter (#767)
* feat: row_exists and read_row (#778)
* feat: read_modify_write and check_and_mutate_row (#780)
* feat: sharded read rows (#766)
* feat: ping and warm with metadata (#810)
* feat: mutate rows batching (#770)
* chore: restructure module paths (#816)
* feat: improve timeout structure (#819)
* fix: api errors apply to all bulk mutations
* chore: reduce public api surface (#820)
* feat: improve error group tracebacks on < py11 (#825)
* feat: optimize read_rows (#852)
* chore: add user agent suffix (#842)
* feat: optimize retries (#854)
* feat: add test proxy (#836)
* chore(tests): add conformance tests to CI for v3 (#870)
* chore(tests): turn off fast fail for conformance tets (#882)
* feat: add TABLE_DEFAULTS enum for table method arguments (#880)
* fix: pass None for retry in gapic calls (#881)
* feat: replace internal dictionaries with protos in gapic calls (#875)
* chore: optimize gapic calls (#863)
* feat: expose retryable error codes to users (#879)
* chore: update api_core submodule (#897)
* chore: merge main into experimental_v3 (#900)
* chore: pin conformance tests to v0.0.2 (#903)
* fix: bulk mutation eventual success (#909)
---------
Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
parthea pushed a commit that referenced this pull request Mar 6, 2026
Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api: datastoreIssues related to the Datastore API.api: pubsubIssues related to the Pub/Sub API.api: storageIssues related to the Cloud Storage API.cla: yesThis human has signed the Contributor License Agreement.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Sphinx needs to document methods from _implicit_environ

4 participants

@tseaver@coveralls@dhermes@googlebot