How to document properties parameters?
sdiebolt opened this issue · comments
Samuel Le Meur-Diebolt commented
I'm wondering how to porperly document property getters and setters. Until now, I've been documenting everything in the getter, leaving the setter without docstring. That way, the generated HTML documentation shows the whole property documentation. However, I get a PR02: Unknown parameters
warning on my getters since they have a Parameters
section documenting the parameters of the setter. What am I doing wrong?