Giter Site home page Giter Site logo

Comments (5)

keleshev avatar keleshev commented on July 23, 2024

This was intended by me, but nothing like that is mentioned in PEP257 itself.

For me a nested class (also nested function) is automatically something private, i.e. it is not necessary to document it, like a function that starts with an underscore.

Still not sure how pep257 should behave in this case, and in case of nested functions.

from pydocstyle.

JensRantil avatar JensRantil commented on July 23, 2024

The reason I filed the bug is that I tend to put class specific exceptions/errors nested in another class is they are only thrown by that class. Maybe doing it that way is not the Pythonic way of doing it, I don't know...

from pydocstyle.

adiroiban avatar adiroiban commented on July 23, 2024

If nested stuff is private, then start its name with '_*' . I also use nested functions, a lot ... ex Twisted code.

from pydocstyle.

Nurdok avatar Nurdok commented on July 23, 2024

My two cents on this issue:

Nested classes are public. They are public because names defined inside a class definitions are accessible from outside of the class, such as methods, class methods, class members, etc. For all of these, we consider them public unless they are prepended with an underscore.

Nested function are private. They are private because names inside a function definitions are not accessible from the outside, namely local variables.

from pydocstyle.

Nurdok avatar Nurdok commented on July 23, 2024

Just to make it clear - in "nested class" I meant a class inside a class, not a class inside a function.

from pydocstyle.

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.