Fix ignoring undocumented instance attributes

Fixes #451
readthedocs · Jun 22, 2024 · fbacc72 · fbacc72
1 parent 2172f92
commit fbacc72
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 1 deletion.
diff --git a/autoapi/_parser.py b/autoapi/_parser.py
@@ -213,7 +213,7 @@ def parse_functiondef(self, node):
             for child in node.get_children():
                 if isinstance(child, (astroid.nodes.Assign, astroid.nodes.AnnAssign)):
                     child_data = self._parse_assign(child)
-                    result.extend(data for data in child_data if data["doc"])
+                    result.extend(data for data in child_data)
 
         return result
 

diff --git a/docs/changes/451.bugfix b/docs/changes/451.bugfix
@@ -0,0 +1 @@
+Fix ignoring undocumented instance attributes
diff --git a/tests/python/test_pyintegration.py b/tests/python/test_pyintegration.py
@@ -51,6 +51,7 @@ def check_integration(self, parse, example_path):
         assert foo.find(id="example.Foo.Meta")
 
         # Check that class attributes are documented
+        assert foo.find(id="example.Foo.attr")
         attr2 = foo.find(id="example.Foo.attr2")
         assert "attr2" in attr2.text
         # Check that attribute docstrings are used