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

How to document properties parameters? #486

Open
sdiebolt opened this issue Aug 8, 2023 · 0 comments
Open

How to document properties parameters? #486

sdiebolt opened this issue Aug 8, 2023 · 0 comments

Comments

@sdiebolt
Copy link
Contributor

sdiebolt commented Aug 8, 2023

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant