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

documentation on how docstrings of __init__() methods are processed #261

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions pdoc/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,18 @@ it will automatically attach the docstring for `A.test` to
In the default HTML template, such inherited docstrings are greyed out.


### Docstring of `__init__()` method
[init docstring]: #docstring-of-__init__-method

Note that the docstring of a class's `__init__()` method is directly
appended to the class's docstring when generating the documentation
with `pdoc`. A valid approach is to not document the `__init__()` method
at all and directly add, for example, a `Parameters` section to the
docstring of the class that describes the arguments of the `__init__()`
method. That way all necessary information on how to instantiate the
class is directly provided by the docstring of the class.


### Docstrings for variables
[variable docstrings]: #docstrings-for-variables

Expand Down