x
/
doc8
Code Issues Proposed changes

Document the exceptions are for RST format only 

Change-Id: Ia0d17b89e0020fd32626cf6510d9862421a853c6
This commit is contained in:
Joshua Harlow 2014-09-05 17:18:25 -07:00
parent a16a84e37b
commit 4785188023
2 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.rst
View File

@ -36,10 +36,10 @@ Command line usage
What is checked: What is checked:
- invalid rst format - D000 - invalid rst format - D000
- lines should not be longer than 79 characters - D001 - lines should not be longer than 79 characters - D001
- exception: line with no whitespace except in the beginning - RST exception: line with no whitespace except in the beginning
- exception: lines with http or https urls - RST exception: lines with http or https urls
- exception: literal blocks - RST exception: literal blocks
- exception: rst target directives - RST exception: rst target directives
- no trailing whitespace - D002 - no trailing whitespace - D002
- no tabulation for indentation - D003 - no tabulation for indentation - D003
- no carriage returns (use unix newlines) - D004 - no carriage returns (use unix newlines) - D004

8
doc8/main.py
View File

@ -20,10 +20,10 @@
What is checked: What is checked:
- invalid rst format - D000 - invalid rst format - D000
- lines should not be longer than 79 characters - D001 - lines should not be longer than 79 characters - D001
- exception: line with no whitespace except in the beginning - RST exception: line with no whitespace except in the beginning
- exception: lines with http or https urls - RST exception: lines with http or https urls
- exception: literal blocks - RST exception: literal blocks
- exception: rst target directives - RST exception: rst target directives
- no trailing whitespace - D002 - no trailing whitespace - D002
- no tabulation for indentation - D003 - no tabulation for indentation - D003
- no carriage returns (use unix newlines) - D004 - no carriage returns (use unix newlines) - D004