Comments (14)
Sure! Pull requests are welcome 😉
from pydocstyle.
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.
~/.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.
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.
What do you use if not ~/.config/flake8
. setup.cfg
and tox.ini
are also good ideas.
from pydocstyle.
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.
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.
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.
@kdeldycke are you working on this, or planning to?
from pydocstyle.
@Nurdok not at all. Feel free to take over this issue ! :)
from pydocstyle.
👍 any progress on this?
from pydocstyle.
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.
Great. Could youp lease add documentation for this please? Specifically to the front page of this repo (README.md)
from pydocstyle.
This is a better opportunity to start using readthedocs.org and have real documentation for this project.
from pydocstyle.
Related Issues (20)
- option to ban `noqa` comments that don't specify a code
- D102 - false positive on overload with comment
- cosmetic bug: wrong version stamp in webpage title: 1.0.0 instead of 2.1.1
- The match-dir parameter is not used. HOT 4
- Not detecting wrong DocStrings HOT 1
- Your website is down - https://pydocstyle.org HOT 3
- Crash with simple f-string HOT 7
- Docs website is down? HOT 1
- sdist: PKG-INFO should list LICENSE-MIT in License-File
- `D300` and `D301` false positives on docstrings with escaped triple quotes in them
- Should `__main__.py` really be considered a public module?
- Option to not report error for empty file HOT 1
- test_simple_fstring and test_fstring_with_args fail with Python 3.12 beta HOT 2
- 6.3.0: incorrect version in pyproject.toml?🤔 HOT 2
- pydocstyle 6.3.0 fails silently on a python script that has no .py extension
- Rule for missing PEP 698 `@overrides` decorators?
- Keyword Args not recognized in Google convention with no return
- Python3.12: Two tests fail HOT 1
- Google convention section names not properly checked
- D417 not raised in a standard Google configuration with missing arguments descriptions
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from pydocstyle.