search

daizutabi / mkapi

A plugin for MkDocs to generate API documentation
https://daizutabi.github.io/mkapi/
MIT License
103 stars 19 forks source link

[Enhancement] hide __init__() method if no docstring #4

Closed hcoohb closed 4 years ago

hcoohb commented 4 years ago

Another possible enhancement could be to hide the init() method when displaying a class if the docstring is empty, since all parameters appear in the class header and the docstring of the class supposedly document those.

Currently a section with the init method is created with the following content : Initialize self. See help(type(self)) for accurate signature. even if there is no docstring

daizutabi commented 4 years ago

I fixed the problem. Please use Version 0.5.1 or later. Current behavior: If there is a class header docstring, an init() docstring is ignored regardless of its contents. If there is not a class header docstring AND an init() docstring does not start with Initialize self, the init() docstring is transfered to the class header docstring.

hcoohb commented 4 years ago

Perfect, thanks for the quick resolution again!