doc8 icon indicating copy to clipboard operation
doc8 copied to clipboard

--max-line-length not working

Open madhavajay opened this issue 3 years ago • 0 comments

I tried to use doc8 as a pre-commit hook but the checks that passed on my Mac were failing in Github CI. I even logged into the remote system using tunshell to debug and if I set the --max-line-length to something high like 120 it passes on the Github CI linux machine. So my only conclusion is that somehow the way doc8 on ubuntu was interpreting the .rst files and their line breaks was somehow different to MacOS?

setup.cfg

[doc8]
max-line-length=88

.pre-commit-config.yaml

- repo: https://github.com/PyCQA/doc8
  rev: 0.8.1
  hooks:
    - id: doc8
      args: ["--max-line-length=88", "--config=setup.cfg", "docs"]

The file installing.rst claims to be LF like all our .rst files.

I tried multiple different versions of the pre-commit hook, including the stable 0.8.1 and even just running the local pip installed doc8 0.8.1 with either the setup.cfg max line length or the direct CLI flag, or both.

Screen Shot 2020-09-17 at 10 13 03 am

https://github.com/OpenMined/PySyft/runs/1126002765?check_suite_focus=true

Here is an example file that fails on CI: https://github.com/OpenMined/PySyft/pull/4564/files#diff-ba34ab03bbb1d37909716574e6134def

For now I have simply removed the doc8 checks again and force pushed.

Perhaps I am simply mis-understanding something here about the line breaks and doc8 on mac vs ubuntu?

madhavajay avatar Sep 17 '20 01:09 madhavajay