adding docs about using pyproject.toml
#834
Conversation
|
@epage mind have look and approve CI run, pls 🐰 |
| ### Supported config files | ||
|
|
||
| The default option is setting the configuration in `typos.toml`, `_typos.toml` or `.typos.toml`. | ||
|
|
||
| In addition, you can set the same configuration with standard python's config file `pyproject.toml` by adding `[tool.typos.xyz]` where the `xyz` is the same as in default `_typos.toml` so the sample configuration above will be: | ||
| ```toml | ||
| [tool.typos.default] | ||
| extend-ignore-identifiers-re = ["AttributeID.*Supress.*"] | ||
|
|
||
| [tool.typos.default.extend-identifiers] | ||
| AttributeIDSupressMenu = "AttributeIDSupressMenu" | ||
|
|
||
| [tool.typos.default.extend-words] | ||
| teh = "teh" | ||
| ``` | ||
|
|
||
| ### Integrations |
There was a problem hiding this comment.
FYI this was covered in #826. If we want to expand it, we should probably do it in that area within the context of whats there
There was a problem hiding this comment.
I may suggest to have it readme as it is easy to find and the other location was not discoverable =( so I found it based on issue and merged PR...
There was a problem hiding this comment.
The README is focused on being a quick start, delegating to this file for the details.
There was a problem hiding this comment.
Yes but for some cases like us, the need to add a new config in the root could be a deal breaker so in such cases, we cannot use it... so how about making it lighter #834 (comment)?
|
This is not aligning with the goal of this section of the documentation. This is a getting started and isn't meant to cover every feature people might need to use. |
never mined, just wanted to help; but you call and approach in the end, good luck :) |
Adding note about using
pyproject.tomlwhich was added recently:ref:
pyproject.tomlfiles #790 (comment)