From: Vladimír Vondruš <mosra@centrum.cz>
Date: Mon, 13 Feb 2023 20:27:03 +0000 (+0100)
Subject: documentation/python: test using :property: in a class docstring.
X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~cjwatson/git?a=commitdiff_plain;h=992d09221fbfd79130e2f63263057a4d73e6c777;p=blog.git

documentation/python: test using :property: in a class docstring.

It works, I just wasn't sure if there wasn't something special regarding
docstrings so I had to check explicitly.
---

diff --git a/documentation/test_python/content_parse_docstrings/content_parse_docstrings.Class.html b/documentation/test_python/content_parse_docstrings/content_parse_docstrings.Class.html
index 164eacfe..e9a1ea74 100644
--- a/documentation/test_python/content_parse_docstrings/content_parse_docstrings.Class.html
+++ b/documentation/test_python/content_parse_docstrings/content_parse_docstrings.Class.html
@@ -44,6 +44,10 @@ even from a summary.</p>
               <a href="#a_property" class="m-doc">a_property</a>: float <span class="m-label m-flat m-warning">get</span>
             </dt>
             <dd>The <a class="m-doc" href="content_parse_docstrings.Class.html#a_property">a_property</a> has a <em>serious</em> docstring.</dd>
+            <dt id="another_property">
+              <a href="#another_property" class="m-doc-self">another_property</a> <span class="m-label m-flat m-warning">get</span>
+            </dt>
+            <dd>This property is documented in the class</dd>
           </dl>
         </section>
         <section>
diff --git a/documentation/test_python/content_parse_docstrings/content_parse_docstrings.py b/documentation/test_python/content_parse_docstrings/content_parse_docstrings.py
index c248a4c2..7e7f9de1 100644
--- a/documentation/test_python/content_parse_docstrings/content_parse_docstrings.py
+++ b/documentation/test_python/content_parse_docstrings/content_parse_docstrings.py
@@ -9,6 +9,8 @@ class Class:
     With a multi-line summary. Relative reference to :ref:`a_property` works
     even from a summary.
 
+    :property another_property: This property is documented in the class
+
     And class **details** as well."""
 
     @property
@@ -17,6 +19,10 @@ class Class:
 
         And property **details** as well."""
 
+    @property
+    def another_property():
+        pass
+
 class Enum(enum.Enum):
     """This enum has a *serious* docstring. :ref:`VALUE` works from a summary.