MDS/openide
1
0
Fork 0
mirror of https://gitflic.ru/project/openide/openide.git synced 2026-04-21 14:01:44 +07:00
Code Issues Packages Projects Releases Wiki Activity

PY-33341, PY-56416, PY-28900: Render attributes and init params description in the class documentation

Browse Source 
PY-33341: Now we render the “Attributes” section in the class documentation, it also allows to describe inherited attributes. (Previously we didn’t render it at all)
PY-56416: In the attribute documentation popup we are able to render attribute description from class docstring. (Previously we took documentation only explicitly from attribute one-line docstring)
PY-33341: We render the “Parameters” section in the class documentation for init parameters, described in the class docstring. (Previously user couldn't use class docstring to describe init parameters)
PY-28900: For the init parameter documentation we take the description from the class docstring if init doesn't have its own docstring. (Previously we took parameter description only from init docstring)

GitOrigin-RevId: d67bf49c72cf7a3634805a6e310c943f1ea848d1
This commit is contained in:
Irina.Fediaeva
2022-08-26 14:29:59 +03:00
committed by intellij-monorepo-bot
parent 6e8d9adaf8
commit cb8edc622b
52 changed files with 584 additions and 77 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
python/testData/quickdoc/ClassAttributeDescriptionFromClassDocstringRest.html Normal file
View File

@@ -0,0 +1 @@
<html><body><div class='definition'><pre>Class attribute <b>attr</b> of <a href="psi_element://#typename#ClassAttributeDescriptionFromClassDocstringRest.MyClass">ClassAttributeDescriptionFromClassDocstringRest.MyClass</a><br>attr: <a href="psi_element://#typename#int">int</a> = 0</pre></div><div class='content'>attr description</div></body></html>