You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The document is rendered differently depending on whether I use #: before the attribute or the class docstring to document the attribute:
fromtypingimportOptionalclassPoint:
""" A class representing a point. Attributes: x: Position X. y: Position Y. """x: inty: intclassSquare:
"""A class representing a square figure."""#: Square's start position (top-left corner).start: Point#: Square width.width: int#: Square height.height: int@propertydefend(self) ->Point:
"""Square's end position (bottom-right corner)."""returnPoint(self.start.x+self.width, self.start.y+self.height)
classRectangle:
""" A class representing a square figure. Attributes: start: Rectangle's start position (top-left corner). width: Rectangle width. height: Rectangle width. """start: Pointwidth: intheight: int@propertydefend(self) ->Point:
"""Rectangle's end position (bottom-right corner)."""returnPoint(self.start.x+self.width, self.start.y+self.height)
How to Reproduce
$ git clone https://github.com/jack1142/sphinx-issue-9585
$ cd sphinx-issue-9585
$ pip install sphinx
$ cd docs
$ make html
$ # open _build/html/index.html and see the issue
Expected behavior
I expected both of these cases to be rendered the same. Not sure in which way (I think I prefer to use the type field, as in the way the Rectangle is shown in, and I think it should also apply to the property in there even though it doesn't here for some reason), preferably it would be configurable.
This might be related to #7582 but none of the comments there seem to mention the Python type annotations, they all only mention Sphinx's type annotation so I feel this might be a different issue.
The text was updated successfully, but these errors were encountered:
Describe the bug
The document is rendered differently depending on whether I use
#:
before the attribute or the class docstring to document the attribute:How to Reproduce
Expected behavior
I expected both of these cases to be rendered the same. Not sure in which way (I think I prefer to use the type field, as in the way the Rectangle is shown in, and I think it should also apply to the property in there even though it doesn't here for some reason), preferably it would be configurable.
Your project
https://github.com/jack1142/sphinx-issue-9585
(sic! I reused the repository from a different issue)
Screenshots
Here's a link to the generated docs:
https://sphinx-issue-9585.readthedocs.io/en/latest/
(sic! I reused the repository from a different issue)
OS
Windows 10, Ubuntu 18.04
Python version
3.7, 3.8, 3.9
Sphinx version
4.1.2
Sphinx extensions
sphinx.ext.autodoc
Extra tools
No response
Additional context
This might be related to #7582 but none of the comments there seem to mention the Python type annotations, they all only mention Sphinx's type annotation so I feel this might be a different issue.
The text was updated successfully, but these errors were encountered: