-
-
Notifications
You must be signed in to change notification settings - Fork 2.2k
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
Reimplement property object description for python #7523
Comments
Not sure if this is the right place, but I think it would be extremely helpful if the generated documentation could not just show THAT something is a property, but also, indicate whether it has got a getter, setter, deleter. |
I think indicating a property supports getter, setter and deleter is another topic. So I just made #9087 to support it. |
I think this has been almost implemented. So I will try to confirm it works in the 4.0 later. |
Is your feature request related to a problem? Please describe.
In Sphinx-2.1.0, we started to support property objects #6320. At that time, it is implemented as a kind of method. But we have some discussions #6785 and #7068 to change it to a kind of attribute.
Finally, we agreed to implement it as an independent type: property. At same time, it is very similar to attributes. So we also support to refer it as attributes.
Describe the solution you'd like
py:property
directive.py:prop
andpy:attr
role.py:property
directive.py:property
directive.py:prop
andpy:attr
role.The text was updated successfully, but these errors were encountered: