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

Stop using undoc-members #1800

Closed
dhermes opened this issue May 17, 2016 · 5 comments
Closed

Stop using undoc-members #1800

dhermes opened this issue May 17, 2016 · 5 comments
Assignees
Labels
type: question Request for information or clarification. Not an issue.

Comments

@dhermes
Copy link
Contributor

dhermes commented May 17, 2016

See https://github.com/GoogleCloudPlatform/gcloud-python/pull/1772/files#r63362850

@dhermes dhermes added type: question Request for information or clarification. Not an issue. docs labels May 17, 2016
@dhermes
Copy link
Contributor Author

dhermes commented May 17, 2016

AFAIK we use undoc-members to make sure all public methods / attributes are documented even if we forget to provide a docstring. @tseaver I'm not sure what issue you were trying to raise, could you elaborate?

@tseaver
Copy link
Contributor

tseaver commented May 17, 2016

If we don't provide docs, it isn't part of the API, even if it happens not to start with an _. This issue may be moot, as pylint may barf w/o a docstring.

@dhermes
Copy link
Contributor Author

dhermes commented May 17, 2016

Yeah but the way we've built this library, everything that happens to not start with an _ is intended to be public. So undoc-members is a protection against human error (like I said, if we forgot to provide a docstring).

@tseaver
Copy link
Contributor

tseaver commented May 17, 2016

I would say that exposing the syntax/signature without explaining the semantics isn't helping the user: it would be better to have tox -e docs barf due to lack of coverage.

@dhermes
Copy link
Contributor Author

dhermes commented May 17, 2016

I'm totally fine with that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: question Request for information or clarification. Not an issue.
Projects
None yet
Development

No branches or pull requests

2 participants