-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Adding check that all public modules are documented. #1375
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.
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
Conversation
3adfee2 to
8caffb9
Compare
|
@tseaver PTAL |
scripts/verify_included_modules.py
Outdated
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
8caffb9 to
8285be2
Compare
|
@tseaver PTAL. This time At this point we should discuss which need to be actually documented and which I should add to When running locally, the errors are: |
|
@tseaver PTAL |
8285be2 to
c04d18d
Compare
|
LGTM |
|
@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 |
|
@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
c04d18d to
722d6ab
Compare
Also making sure `tox -e docs` **always** gets run in update_docs.sh, to verify the docs build successfully at all times.
722d6ab to
27da413
Compare
|
I think we should ignore:
But we should probably document all of these:
|
|
Everything except |
|
Cool, LGTM. |
Adding check that all public modules are documented.
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?
Fixes #714.
Also: making prints to
stderrPython 3 friendly inrun_pylint.py.@tseaver Note the
docsrule 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 theIGNORED_MODULESset or if we should add them to anrstfile.