Skip to content
This repository has been archived by the owner on Nov 3, 2023. It is now read-only.

It should be possible to get a list of possible errors #61

Closed
Nurdok opened this issue Dec 28, 2013 · 4 comments
Closed

It should be possible to get a list of possible errors #61

Nurdok opened this issue Dec 28, 2013 · 4 comments

Comments

@Nurdok
Copy link
Member

Nurdok commented Dec 28, 2013

I tried to use the script version from the "rewrite" branch. It seemed that the error numbers were changed and are not longer in sync with the README. This is expected, but there should be a way to ask the tool to describe all the possible errors.
A possible interface would be:

$ pep257 --error-list

D100: Module is missing docstring.
D101: Class is missing docstring.
...

Where if --explain is specified as well, the longer description is printed.

@adiroiban
Copy link

Why would you need that!?

@Nurdok
Copy link
Member Author

Nurdok commented Apr 12, 2014

Here's an actual use case - I want to use pep257.py as a mandatory part of our build system at work. However, we don't agree with all the rules of PEP257, so we would like to ignore some of the errors. It should be possible to get a list of them to go through, rather than just wait for an unwanted error to pop up and then dismiss it.

@adiroiban
Copy link

Fair enough. I just ran the code on my code base and decide from that start what to filter.

In an ideal world no filter would be require... see pep8 and pyflakes.

Unfortunately, pep257 has some ugly false positives.

Good luck

@Nurdok
Copy link
Member Author

Nurdok commented Oct 12, 2015

I'm closing this as the documentation now lists all possible error codes.

@Nurdok Nurdok closed this as completed Oct 12, 2015
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants