Giter Site home page Giter Site logo

Comments (2)

jsh9 avatar jsh9 commented on June 20, 2024

Hi @Oreilles , thanks for submitting this issue.

From my perspective, the potential difficulty with this suggestion is: instance attributes are difficult to check.

Here's an example of "class attributes" and "instance attributes", in case there are any confusions:

class Car:
    # Class attribute
    num_wheels = 4
    
    def __init__(self, make, model):
        # Instance attributes
        self.make = make
        self.model = model

According to the Google style guide, if we are to document public attributes, we should document both class attributes and instance attributes.

The order and type hints of instance attributes are not easy to check (we may not want to enforce order anyways).

from pydoclint.

Gabriel-p avatar Gabriel-p commented on June 20, 2024

Came here after realizing that my dataclass attributes were not being checked. Maybe an option that can be set to enforce checking class attributes with caveats shown on screen?

from pydoclint.

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.