Commits

Tay Ray Chuan committed ef99412

test_autodoc: add test for doc comment

Right now, the generated doc shows "Class to document.", instead of
"Class instance to document."

Comments (0)

Files changed (2)

tests/root/autodoc.txt

 
    Additional content.
 
+.. autodata:: ClassInstance
+
 .. autoclass:: Outer
    :members: Inner
 

tests/test_autodoc.py

         self.inst_attr_string = None
         """a documented instance attribute"""
 
+#: Class instance to document.
+ClassInstance = Class("an arg")
 
 class CustomDict(dict):
     """Docstring."""
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.