Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add more info on structuring config in pyproject.toml to the README #92

Open
RNKuhns opened this issue Jul 16, 2022 · 1 comment
Open

Comments

@RNKuhns
Copy link

RNKuhns commented Jul 16, 2022

It would be useful to include some additional documentation about how to structure the config file when using pyproject.toml.

I ran into some problems setting up the config file to ignore errors related to #78.

It looks like a pyproject.toml that includes something like what I've posted below, will work:

[tool.doc8]
max-line-length = 88
ignore = ["D004"]

However, based on the existing README, I initially didn't have the error quoted or in brackets. Not quoting the error codes leads to errors when reading the pyproject.toml file and leaving out the brackets from the ignore also appeared to make it so that doc8 didn't recognize what was being passed.

Can you confirm the above should work as expected to ignore error code D004? If so, should be an easy addition to the README to clarify for others.

@adam-grant-hendry
Copy link

@RNKuhns This doesn't seem to work for me (see my comment).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants