Failed to correctly document subclass or `property`.

Anonymous avatarAnonymous created an issue

Consider the class:

class EventProperty(property):
    """ Used to declare events on the class ...  """
   
    def fire(self, *args, **kwargs):
        """ Fire the event.  """
        pass

and the associated rst file:

**************
pkg.autodocbug
**************

.. automodule:: pkg.autodocbug
   :members:

The resulting (HTML) documentation seems to think EventProperty is a function and does not document its members. Now, if I change the subclass of EventProperty as follows:

class EventProperty(object):
    """ Used to declare events on the class ...  """
   
    def fire(self, *args, **kwargs):
        """ Fire the event.  """
        pass

then the documentation is as expected.

Comments (0)

  1. Log in to comment
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.