pydocstyle icon indicating copy to clipboard operation
pydocstyle copied to clipboard

Feature request: add support for instance variable docstrings

Open plinss opened this issue 5 years ago • 0 comments

pdoc3 currently doesn't generate documentation for instance variables unless they have docstrings. It would be very useful to have a rule that enforced the presence of docstrings for instance variables.

e.g.:

class Test:
    def __init__(self, value):
        self.value = value
        """This is a value."""

plinss avatar Feb 03 '20 19:02 plinss