Giter Site home page Giter Site logo

pep257 configuration file about pydocstyle HOT 14 CLOSED

pycqa avatar pycqa commented on June 25, 2024
pep257 configuration file

from pydocstyle.

Comments (14)

keleshev avatar keleshev commented on June 25, 2024

Sure! Pull requests are welcome 😉

from pydocstyle.

kdeldycke avatar kdeldycke commented on June 25, 2024

I'll wait for the merging of your rewrite branch.

In the mean time, do you have any preferences on the naming and default location ?

from pydocstyle.

keleshev avatar keleshev commented on June 25, 2024

~/.config/pep257 should be best. Do you know if pep8/pylint/flake8/pychecker use any local (per-project) config files? That could be interesting.

Ini-style config is probably the best choice, since it's supported by standard library. Take a look at this config example. It allows for configs like:

[pep257]
--explain
--ignore=D101,D202
--match='(?!test_).*\.py'

from pydocstyle.

sigmavirus24 avatar sigmavirus24 commented on June 25, 2024

We honor setup.cfg if I remember correctly. Possibly also tox.ini but I think that was deprecated. I'm also not sure if we support ~/.config/flake8 any longer.

[#]: We == Flake8

from pydocstyle.

keleshev avatar keleshev commented on June 25, 2024

What do you use if not ~/.config/flake8. setup.cfg and tox.ini are also good ideas.

from pydocstyle.

adiroiban avatar adiroiban commented on June 25, 2024

Before having a configuration file, I prefer to have PEP257Checker(options). options can be a simple key/value dict of Bunch like object.

from pydocstyle.

adiroiban avatar adiroiban commented on June 25, 2024

btw. I am not using (or plan to use) pep256 directly from the command line. Rather I load a file in memory once and then send the content to many linters and checkers.

from pydocstyle.

treyhunner avatar treyhunner commented on June 25, 2024

I would like to see setup.cfg support. I have particular files I would like to omit from checking and I don't want to type them at the command line ever time.

from pydocstyle.

Nurdok avatar Nurdok commented on June 25, 2024

@kdeldycke are you working on this, or planning to?

from pydocstyle.

kdeldycke avatar kdeldycke commented on June 25, 2024

@Nurdok not at all. Feel free to take over this issue ! :)

from pydocstyle.

oryband avatar oryband commented on June 25, 2024

👍 any progress on this?

from pydocstyle.

Nurdok avatar Nurdok commented on June 25, 2024

Not yet, but I consider this the next big thing.

On Thu, 11 Dec 2014 12:50 pm Ory Band [email protected] wrote:

[image: 👍] any progress on this?


Reply to this email directly or view it on GitHub
#58 (comment).

from pydocstyle.

oryband avatar oryband commented on June 25, 2024

Great. Could youp lease add documentation for this please? Specifically to the front page of this repo (README.md)

from pydocstyle.

sigmavirus24 avatar sigmavirus24 commented on June 25, 2024

This is a better opportunity to start using readthedocs.org and have real documentation for this project.

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.