Skip to content
This repository has been archived by the owner on Nov 3, 2023. It is now read-only.

Private module definition is inconsistent with private method definition. #414

Closed
proofit404 opened this issue Oct 5, 2019 · 2 comments
Closed

Comments

@proofit404
Copy link

Probably a duplicate of #323

Hi, thanks for the great package and your efforts to maintain it!

If I mark a class as private, its methods are also considered private. So _Foo.bar doesn't need the documentation string.

But if I mark a package as private, its modules aren't considered private as well. So it's still required to put a documentation string on top of _foo/bar.py.

Is it intended behavior?

Have a good day 🎉

Best regards,
Artem.

@samj1912
Copy link
Member

Closed via #494

@proofit404
Copy link
Author

Thanks!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants