Git Product home page Git Product logo

Comments (4)

Chilipp avatar Chilipp commented on August 30, 2024

Good point, yes, that is at the moment not working. The only workaround is to create a class_variable and override it in the corresponding instance

class Example():
    """
    class documentation
    """
    class_variable = 12 #: This is a classvariable

    instance_variable = None #: This is an instance variable and will be overwritten
    
    def __init__(self):
        """
        constructor doc
        """
        self.instance_variable = 34 #: This is an instance variable

But you are right, since autodoc is able to put the instance_variable here, autodocsumm should as well

from autodocsumm.

maeddlae avatar maeddlae commented on August 30, 2024

Do you plan to fix this in the near future? I am asking because autodocsumm perfectly fits my needs. But showing the attributes is critical for me..

from autodocsumm.

Chilipp avatar Chilipp commented on August 30, 2024

Yes, I will work on it before Sunday. I don't think it should be too difficult.

from autodocsumm.

maeddlae avatar maeddlae commented on August 30, 2024

Great, thanks a lot. Then I will wait for your update:-)

from autodocsumm.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.