Work at SourceForge, help us to make it a better place! We have an immediate need for a Support Technician in our San Francisco or Denver office.

Close

#23 Doc incorrect when nested class involved

closed-accepted
Riaan Booysen
None
5
2001-08-18
2001-08-15
Anonymous
No

It appears that, when code includes a construct such
as the following the documentation generator fails to
recognise that one class is nested within another.
Consequence is that all documentation items from the
nested class on are treated as having come from a new
unnested class.

class foo:
class bar:
def a ( self ):
pass
def b ( self, x ):
pass

In this case 'b' will be documented as if it were a
method in class 'bar' (rather than 'foo').

Discussion

  • Riaan Booysen
    Riaan Booysen
    2001-08-18

    • status: open --> open-accepted
     
  • Riaan Booysen
    Riaan Booysen
    2001-08-18

    Logged In: YES
    user_id=438

    Yes, I'm fully aware of this limitation to the source parser. The parser was originally based on a Python standard
    module that also can't handle nested classes (and functions).
    This is not an easy change to make (I've spent some time on it already) but I will get to it.

    I'm moving this to a Feature Request.

     
  • Riaan Booysen
    Riaan Booysen
    2001-08-18

    • assigned_to: nobody --> riaan
    • status: open-accepted --> closed-accepted
     
  • Riaan Booysen
    Riaan Booysen
    2001-08-18

    Logged In: YES
    user_id=438

    Bill Bell has accepted the challenge to improve this situation. Thanks Bill!