FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Adding check that all public modules are documented. by dhermes · Pull Request #1375 · googleapis/google-cloud-python · GitHub

/ google-cloud-python Public

Adding check that all public modules are documented. - #1375

Merged
dhermes merged 3 commits into
googleapis:masterfrom
dhermes:check-left-out-modules
Feb 12, 2016
ConversationCommits (3)ChecksFiles changed
Merged

Adding check that all public modules are documented.#1375
dhermes merged 3 commits into
googleapis:masterfrom
dhermes:check-left-out-modules

Conversation

dhermes commented Jan 9, 2016

Copy link
Copy Markdown
Contributor

Fixes #714.

Also: making prints to stderr Python 3 friendly in run_pylint.py.

@tseaver Note the docs rule will fail here. This was intentional. I wanted to display which modules were still undocumented so we could discuss if they should be added to the IGNORED_MODULES set or if we should add them to an rst file.

googlebot added the cla: yes This human has signed the Contributor License Agreement. label Jan 9, 2016
dhermes force-pushed the check-left-out-modules branch from 3adfee2 to 8caffb9 Compare January 15, 2016 07:33

dhermes commented Jan 15, 2016

Copy link
Copy Markdown
Contributor Author

@tseaver PTAL

tseaver reviewed Jan 20, 2016
View reviewed changes
Comment thread scripts/verify_included_modules.py Outdated

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

dhermes force-pushed the check-left-out-modules branch from 8caffb9 to 8285be2 Compare January 20, 2016 18:53

dhermes commented Jan 20, 2016

Copy link
Copy Markdown
Contributor Author

@tseaver PTAL. This time docs should fail with an explanation of which modules we leave out.

At this point we should discuss which need to be actually documented and which I should add to IGNORE_MODULES.

When running locally, the errors are:

Found undocumented public modules:
- gcloud.bigquery.query
- gcloud.datastore.helpers
- gcloud.environment_vars
- gcloud.iterator
- gcloud.storage.batch
- gcloud.streaming.buffered_stream
- gcloud.streaming.exceptions
- gcloud.streaming.http_wrapper
- gcloud.streaming.stream_slice
- gcloud.streaming.transfer
- gcloud.streaming.util

dhermes commented Jan 28, 2016

Copy link
Copy Markdown
Contributor Author

@tseaver PTAL

dhermes force-pushed the check-left-out-modules branch from 8285be2 to c04d18d Compare January 28, 2016 23:06

tseaver commented Jan 29, 2016

Copy link
Copy Markdown
Contributor

LGTM

dhermes commented Jan 29, 2016

Copy link
Copy Markdown
Contributor Author

@tseaver There are still questions to resolve.

We have several undocumented modules and need to decide which ones to ignore and which ones need documenting.

I expected the CI to fail but tox -e docs only gets run on merged commits or tagged commits (not on PRs).

dhermes commented Feb 3, 2016

Copy link
Copy Markdown
Contributor Author

@tseaver PTAL, pending question above

Adding check that all public modules are documented.
60bec76 
Fixes googleapis#714.
Addressing review comments.
5c90953 
- Removing accidentally including bigquery module from
  IGNORED_MODULES in verify_include_modules
- Adding Sphinx as a lint dependency (it couldn't be imported)
- Fixing Python 2 style print statements in run_pylint
dhermes force-pushed the check-left-out-modules branch from c04d18d to 722d6ab Compare February 12, 2016 21:33
Updating included docs and ignoring some that need not be public.
27da413 
Also making sure `tox -e docs` **always** gets run in update_docs.sh,
to verify the docs build successfully at all times.
dhermes force-pushed the check-left-out-modules branch from 722d6ab to 27da413 Compare February 12, 2016 21:44

theacodes commented Feb 12, 2016

Copy link
Copy Markdown
Contributor

I think we should ignore:

  • gcloud.streaming.*

But we should probably document all of these:

  • gcloud.bigquery.query
  • gcloud.datastore.helpers - unless there's nothing in here useful to users.
  • gcloud.environment_vars
  • gcloud.iterator - unless it's thoroughly documented by its downstream clients.
  • gcloud.storage.batch

dhermes commented Feb 12, 2016

Copy link
Copy Markdown
Contributor Author

Everything except gcloud.iterator was documented in the latest commit. It definitely should not be user facing, I'm not sure why we made it public.

theacodes commented Feb 12, 2016

Copy link
Copy Markdown
Contributor

Cool, LGTM.

dhermes added a commit that referenced this pull request Feb 12, 2016
Merge pull request #1375 from dhermes/check-left-out-modules
d56ea3d 
Adding check that all public modules are documented.
dhermes merged commit d56ea3d into googleapis:master Feb 12, 2016
dhermes deleted the check-left-out-modules branch February 12, 2016 22:28
dhermes mentioned this pull request Feb 17, 2016
Merged
parthea pushed a commit that referenced this pull request Nov 26, 2025
chore: remove duplicate variable (#1375)
fb0c95e 
The global variable [`_DEFAULT_TOKEN_LIFETIME_SECS`](https://togithub.com/googleapis/google-auth-library-python/blob/main/google/auth/impersonated_credentials.py#L40-L61) is set twice. Can we get rid of this duplicate?
parthea pushed a commit that referenced this pull request Mar 6, 2026
chore(main): release 3.3.6 (#1375)
ae15876 
Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

theacodes

Labels

cla: yes This human has signed the Contributor License Agreement.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

Back | FazBrowse Home | New Git URL