Giter Site home page Giter Site logo

Comments (5)

sigmavirus24 avatar sigmavirus24 commented on July 23, 2024

Is it so this can be ignored more easily?

from pydocstyle.

Nurdok avatar Nurdok commented on July 23, 2024

Yes. I find that docstring in (mostly empty) __init__.py files are usually ignored, as opposed to regular modules.

from pydocstyle.

jayvdb avatar jayvdb commented on July 23, 2024

If this is done, I suggest it should only a different code if the init.py is effectively empty, and preferably without imports. But in that case, why not just exclude the init.py entirely?

from pydocstyle.

sigmavirus24 avatar sigmavirus24 commented on July 23, 2024

@jayvdb No one is arguing that this should be off by default but that it should just be an entirely separate error.

from pydocstyle.

jayvdb avatar jayvdb commented on July 23, 2024

I didnt mention 'default'.

I am suggesting it isnt a separate problem deserving of a separate error code unless the contents of the file are somehow different. a/foo/init.py is not substantially different from a/foo.py unless a/foo/bar.py exists.

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.