Skip to content

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
Merged

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

Conversation

@dhermes

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.

@googlebotgooglebot added the cla: yes This human has signed the Contributor License Agreement. label Jan 9, 2016
@dhermes
dhermesforce-pushed the check-left-out-modules branch from 3adfee2 to 8caffb9CompareJanuary 15, 2016 07:33
@dhermes

Copy link
Copy Markdown
ContributorAuthor

@tseaver PTAL

Comment threadscripts/verify_included_modules.py Outdated

This comment was marked as spam.

This comment was marked as spam.

@dhermes
dhermesforce-pushed the check-left-out-modules branch from 8caffb9 to 8285be2CompareJanuary 20, 2016 18:53
@dhermes

Copy link
Copy Markdown
ContributorAuthor

@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

Copy link
Copy Markdown
ContributorAuthor

@tseaver PTAL

@dhermes
dhermesforce-pushed the check-left-out-modules branch from 8285be2 to c04d18dCompareJanuary 28, 2016 23:06
@tseaver

Copy link
Copy Markdown
Contributor

LGTM

@dhermes

Copy link
Copy Markdown
ContributorAuthor

@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

Copy link
Copy Markdown
ContributorAuthor

@tseaver PTAL, pending question above

- 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
dhermesforce-pushed the check-left-out-modules branch from c04d18d to 722d6abCompareFebruary 12, 2016 21:33
Also making sure `tox -e docs` **always** gets run in update_docs.sh,
to verify the docs build successfully at all times.
@theacodes

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

Copy link
Copy Markdown
ContributorAuthor

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

Copy link
Copy Markdown
Contributor

Cool, LGTM.

dhermes added a commit that referenced this pull request Feb 12, 2016
Adding check that all public modules are documented.
@dhermes
dhermes merged commit d56ea3d into googleapis:masterFeb 12, 2016
@dhermes
dhermes deleted the check-left-out-modules branch February 12, 2016 22:28
@dhermesdhermes mentioned this pull request Feb 17, 2016
parthea pushed a commit that referenced this pull request Nov 26, 2025
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

cla: yesThis human has signed the Contributor License Agreement.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@dhermes@tseaver@theacodes@googlebot