Skip to content
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

Drop ':undoc-members:' from Sphinx API docs #1804

Merged
merged 2 commits into from
May 17, 2016
Merged

Drop ':undoc-members:' from Sphinx API docs #1804

merged 2 commits into from
May 17, 2016

Conversation

tseaver
Copy link
Contributor

@tseaver tseaver commented May 17, 2016

Set explicit pylint pattern for no-docstring-rgx. Leaving it unset disabled the missing-docstring check.

Add missing docstrings uncovered thereby.

Closes #1800.

Leaving it unset disabled the 'missing-docstring' check.

Add missing docstrings uncovered thereby.

Closes #1800.
@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label May 17, 2016
@dhermes
Copy link
Contributor

dhermes commented May 17, 2016

So instead of having tox -e docs fail this causes tox -e lint to fail?

@tseaver
Copy link
Contributor Author

tseaver commented May 17, 2016

Yup. tox -e docs doesn't do a member-by-member check.

@dhermes
Copy link
Contributor

dhermes commented May 17, 2016

The other check I was having a hard time remembering is also from PyLint: https://github.com/GoogleCloudPlatform/gcloud-python/blob/763a90c2b435cf9242533c188053e9533046f4f3/scripts/pylintrc_default#L41

It is the check_docs extension (it checks args match and similar).

@dhermes
Copy link
Contributor

dhermes commented May 17, 2016

LGTM

@tseaver tseaver merged commit fcb7085 into googleapis:master May 17, 2016
@tseaver tseaver deleted the 1800-drop_undoc_members branch May 17, 2016 23:40
@dhermes dhermes mentioned this pull request Jun 7, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes This human has signed the Contributor License Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants