Support autodoc extraction for instance attributes set in __init__

Georg Brandl avatarGeorg Brandl created an issue

No description provided.

Comments (4)

  1. ciantic

    Now I must ask, what is the syntax... for especially :type:? (I'm at the very moment trying to convert EpyDoc docstrings to Sphinx)

    I tried and it is not like this:

    # ...
        def __init__(self):
            """Create foo"""
            
            self.is_private = False
            """Is private?
            :type: bool
            """
            
            self.somevariable = "bar"
            """Some cool variable.
            :type: string
            """
    

    I took that from my magic hat (that is EpyDoc hat)... Most notable is the fact that :type: (or Shea R) does not take argument.

    I also noticed that it also ignores notes such as ":note: Something", hmm...

  2. Anonymous

    ciantic From the unit tests:

    def __init__(self, arg):
      #: a documented instance attribute
      self.inst_attr_comment = None
      self.inst_attr_string = None
      """a documented instance attribute"""
    
  3. 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.