Private methods in module docstring? (Python)

Vote count: 0

I've recently begun working on my first Python package intended for public use (as opposed to use by my immediate coworkers). When writing docstring for a module I try to include a general description of the module along with information about any attributes and methods. However, I'm not sure if I should include private methods (methods that start with an underscore). Should I include module level docstring for these methods?

Also, since I'm already here, is there any other information that I should include on the module level?

asked 37 secs ago

user144153

Let's block ads! (Why?)

Private methods in module docstring? (Python)