false positive D004 Found literal carriage return

[danieltuzes]

I get false positive

D004 Found literal carriage return
at every line on Windows. It has been reported here first:
https://bugs.launchpad.net/doc8/+bug/1756704

[adam-grant-hendry]

Same here. Unfortunately, adding this to pyproject.toml:

[tool.doc8]
ignore = [ "D004" ]
max_line_length = 90

as suggested in #92 doesn't seem to ignore the warning for me in VSCode.

System Information

OS: Windows 10
Editor: VSCode 1.71.2
Python: 3.8
doc8: 0.11.2

[adam-grant-hendry]

As a temporary workaround in VSCode, you can manually change line endings for your .rst file from CRLF to LF and resave:

[adam-grant-hendry]

FYI, for those struggling with setting up the reStructuredText extension in VSCode, the extension's read-the-docs is helpful. It's a bit hidden on the extensions page, so I'm adding it here for reference.

Currently, I don't use doc8 since it only seems to warn for that don't affect me and rstcheck plus the live preview are sufficient for me. (Just one developer's two cents.)

[jfthuong]

Add this in your settings.json file:

"restructuredtext.linter.doc8.extraArgs": [
        "--ignore D004"
    ]

And the warning D004 shall disappear (maybe after closing/re-opening or reloading the Window in order to refresh).

[12rambau]

I see here people suggesting workarounds but would'nt it be better to have a solution so that the D004 error is stil tracked even for windows developer ?

[adamtheturtle]

I use the following in a .gitattributes file to avoid this issue and similar:

* text=auto eol=lf