Commit Graph

26 Commits

Author SHA1 Message Date
Stephen Finucane 57d1e9afc9 Project Migration to PyCQA
This change rehomes the project to PyCQA [1] as reported to the
openstack-dev mailing list [2].

[1] https://mail.python.org/pipermail/code-quality/2019-July/001112.html
[2] http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007878.html

Change-Id: I5472bea4994664495220ee4ab565f95666f21eee
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
Depends-On: I740c66cd959db1efa8ca8c9f29d4da4b66fbd993
2019-07-18 14:30:50 +01:00
Ned Batchelder bcdaf5f788 Add a -q option to be silent on success
Change-Id: I5cd7f72694d525420a46e5ec2aca1b394bbf7b90
2017-01-14 20:01:59 -05:00
John L. Villalovos 17f56bb95e Fix grammar issue in README.rst
Fix minor grammar issue in README.rst

Change-Id: I172307c98a3e108bb72a7cc652c5339b409162d0
2015-09-30 16:36:17 -07:00
Joshua Harlow 65138ae3b2 Fix invalid table formatting
Fixes error related to table offsets:

System Message: ERROR/3 (<string>, line 117)

Malformed table. Text in column margin in table line 5.

Change-Id: If46d0ab0dc1fab1adccf63d43433f842ead2123d
2015-09-25 19:34:56 +00:00
Joshua Harlow 062bf244b6 Lowercase the help messages
It seems to be common practice to lowercase these instead
of uppercasing the first word so let's just follow that
practice.

Change-Id: I2c8620257cd9f0566e1d7e1ec88461f18f0bcef4
2015-04-09 08:26:27 -07:00
Joshua Harlow b2adee882b Allow ignore specific error codes in files
Instead of only ignoring full files or ignoring full
codes for all files, allow for ignoring specific errors
for certain files.

Change-Id: I0ebfbe1d2dc68990c84bc0b47d872e44e19b5b2a
2015-03-09 15:57:04 -07:00
Jenkins 00a13a3239 Merge "Allow overriding file encoding" 2014-10-23 19:35:54 +00:00
Joshua Harlow 04a710c687 Allow overriding file encoding
Chardet doesn't always seem to correctly detect files encoding
correctly in all circumstances, to make it so that a user can
specify the exact encoding of there files allow a new config
option and a new CLI option that allows for manually overriding
the encoding that chardet will try to determine.

If enabled chardet detection will no longer run.

Fixes bug 1384463

Change-Id: Ie8baf3f79083e1495c7420a9d0569390cad2115e
2014-10-22 17:30:58 -07:00
Christian Berendt 5a4341727e Add check D005 - no newline at end of file
Change-Id: I160bb7e9b3c904655567caee999ac91366668109
2014-09-30 21:44:59 +02:00
Joshua Harlow 3912dca016 Allow a default_extension to be provided
When a file is found without an extension allow a CLI
provided default_extension to be used in these cases
so that files without extensions can be classified as
known file extension types.

Change-Id: I115ccc92ccd51a7018672b98b639ade30869f939
2014-09-17 17:56:45 -07:00
Joshua Harlow 4785188023 Document the exceptions are for RST format only
Change-Id: Ia0d17b89e0020fd32626cf6510d9862421a853c6
2014-09-05 17:18:25 -07:00
Joshua Harlow a16a84e37b Just remove the features sub-section
The main section already provides a basic overview of what
doc8 can do so it seems not so useful to duplicate that
information in a features sub-section as well.

Change-Id: I8f2215b030e2babcb28d4871239dfa926fec8f69
2014-09-05 17:58:58 +00:00
Joshua Harlow 1b2fccb305 Adjust the description to denote we can parse more than rst
Change-Id: Ic4df88b68b2596796a6906b4f27237a9a705a0db
2014-09-04 16:12:00 -07:00
Joshua Harlow 217eb5e7be Add ignore_paths to ini file and document ini with example
Change-Id: I23c08a5d2c7e85f0bd8cb8f2ad49ac91b46e91ca
2014-09-01 08:30:01 -07:00
Joshua Harlow 73639a04db Correctly ignore parent directories when requested
Also does a ninja fix for undetectable decoding (by
assuming those files are utf-8 as a fallback, which
seems reasonable to do when chardet is unable to
figure out the encoding).

Fixes bug 1363191

Change-Id: I15c172f511a939b21c37f772eb17f78105acf648
2014-08-30 10:46:41 -07:00
Joshua Harlow 478b87b106 Add a sphinx specific mode
When doc8 scans rst files with sphinx specific roles
and references it is unable to determine what those roles
are and then complains that these false positives are
actual errors.

To avoid these types of false positives add a option that
can be provided when running on files that may contain these
types of errors to allow them to be skipped/ignored.

Change-Id: Ia6896617534f68e517d5996d53cf2de274507f56
2014-08-15 15:05:41 -07:00
Joshua Harlow 857f5feaff Update the README.rst with the ignore-path option
Also update the option parser to set the metavar
for the new ignore-path argument to 'path' (instead of
the default of 'IGNORE_PATH' which the option parser
generates automatically).

Change-Id: I13c845c13f4b80511dc4d5b179ba80030e8b9972
2014-08-13 07:49:02 -07:00
Joshua Harlow 08d3c0c2cb Add the new D000 to the rst file
Change-Id: I601a699c80939af8d75ff8cb28e9aae9ef72294c
2014-05-29 15:45:32 -07:00
Joshua Harlow 44e052ae77 Adjust usage doc for new extension argument 2014-05-23 19:09:57 -07:00
Joshua Harlow 810df79e6f Add a few files from the openstack cookiecutter template 2014-05-19 10:04:21 -07:00
Joshua Harlow 300faf7770 Add the max-line-length to the usage help 2014-05-18 18:39:23 -07:00
Joshua Harlow b64cf57446 Update usage docs to match adjusted docstring 2014-05-18 11:06:50 -07:00
Joshua Harlow 0d2c7241eb Update with new help 2014-05-18 02:18:27 -07:00
Joshua Harlow 88d01c0b16 Update usage help 2014-05-17 21:46:36 -07:00
Joshua Harlow e445751310 Update with usage documentation 2014-05-17 21:11:05 -07:00
Joshua Harlow 870b28f86e Add doc8 files 2014-05-17 18:58:47 -07:00