Documenting methods starting with "_" character

[gvvka0327]

I have a class with few methods starting with "_", all those methods were skipped by pdoc in documenting them, like example,

def _get_msg():
"""
Returns commit message
"""

def _get_password(username):
"""
return password
"""

Consistently all the methods like these in all the modules were skipped... all the getting methods are skipped...
Anything I am missing or is it a bug in pdoc tool ?

[mjwillson]

I'm guessing that's intentional, since a _ prefix in python conventionally signifies that something is private / not part of the public API. Hence doesn't make sense to expose in documentation.

[BurntSushi]

@mjwillson Is correct. pdoc is a tool used to discover public API documentation of a module.