Skip to content

BUG - error suppression via ignore-path-error does not work for v1.1.2 and v2.0.0 #188

@mdabrowski1990

Description

@mdabrowski1990

Description

Version 2.0.0 of doc8 has incorrect suppressing of errors using ignore-path-error argument.

Affected version

2.0.0

Example

I used my repo (https://github.com/mdabrowski1990/uds) as an example.

No error suppression

Without error suppression this is result:

 C:\Repos\uds>python -m doc8 docs\source
Scanning...
Validating...
docs\source\pages\knowledge_base\addressing.rst:32: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:33: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:34: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:36: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:37: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:38: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:39: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:40: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:41: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:42: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:43: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:44: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:45: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:46: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:47: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:48: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:49: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:50: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:51: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:52: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:53: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:54: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:60: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:61: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:62: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:64: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:65: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:66: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:67: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:68: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:69: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:70: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:71: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:72: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:111: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:112: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:113: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:115: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:116: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:117: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:118: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:119: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:120: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:121: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:122: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:123: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:124: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:125: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:126: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:127: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:128: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:129: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:130: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:131: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:132: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:133: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:139: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:140: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:141: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:143: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:144: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:145: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:146: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:147: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:148: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:149: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:150: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:151: D001 Line too long
docs\source\pages\user_guide\message_translation.rst:543: D001 Line too long
========
Total files scanned = 21
Total files ignored = 0
Total accumulated errors = 69
Detailed error counts:
    - doc8.checks.CheckCarriageReturn = 0
    - doc8.checks.CheckIndentationNoTab = 0
    - doc8.checks.CheckMaxLineLength = 69
    - doc8.checks.CheckNewlineEndOfFile = 0
    - doc8.checks.CheckTrailingWhitespace = 0
    - doc8.checks.CheckValidity = 0

Error suppression on v1.1.1

 C:\Repos\uds>python -m doc8 docs\source --ignore-path-errors docs\source\pages\knowledge_base\addressing.rst;D001
Scanning...
Validating...
docs\source\pages\user_guide\message_translation.rst:543: D001 Line too long
========
Total files scanned = 21
Total files ignored = 0
Total accumulated errors = 1
Detailed error counts:
    - doc8.checks.CheckCarriageReturn = 0
    - doc8.checks.CheckIndentationNoTab = 0
    - doc8.checks.CheckMaxLineLength = 1
    - doc8.checks.CheckNewlineEndOfFile = 0
    - doc8.checks.CheckTrailingWhitespace = 0
    - doc8.checks.CheckValidity = 0

Error suppression on v2.0.0

(venv312) C:\Repos\uds>python -m doc8 docs\source --ignore-path-errors docs\source\pages\knowledge_base\addressing.rst;D001
Scanning...
Validating...
docs\source\pages\knowledge_base\addressing.rst:32: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:33: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:34: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:36: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:37: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:38: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:39: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:40: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:41: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:42: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:43: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:44: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:45: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:46: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:47: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:48: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:49: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:50: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:51: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:52: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:53: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:54: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:60: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:61: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:62: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:64: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:65: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:66: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:67: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:68: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:69: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:70: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:71: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:72: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:111: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:112: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:113: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:115: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:116: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:117: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:118: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:119: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:120: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:121: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:122: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:123: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:124: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:125: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:126: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:127: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:128: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:129: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:130: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:131: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:132: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:133: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:139: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:140: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:141: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:143: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:144: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:145: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:146: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:147: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:148: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:149: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:150: D001 Line too long
docs\source\pages\knowledge_base\addressing.rst:151: D001 Line too long
docs\source\pages\user_guide\message_translation.rst:543: D001 Line too long
========
Total files scanned = 21
Total files ignored = 0
Total accumulated errors = 69
Detailed error counts:
    - doc8.checks.CheckCarriageReturn = 0
    - doc8.checks.CheckIndentationNoTab = 0
    - doc8.checks.CheckMaxLineLength = 69
    - doc8.checks.CheckNewlineEndOfFile = 0
    - doc8.checks.CheckTrailingWhitespace = 0
    - doc8.checks.CheckValidity = 0

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions