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

Docs request: "default" config #63

Open
jamesbraza opened this issue Aug 23, 2023 · 0 comments
Open

Docs request: "default" config #63

jamesbraza opened this issue Aug 23, 2023 · 0 comments

Comments

@jamesbraza
Copy link

pylint provides an examples module that has several example configs (pylintrc, pyproject.toml). I use these to speed up adding new config options (and it promotes awareness of the available config options).

A huge benefit of this is also revealing the default behavior of all config options.

I think it would be cool if toml-sort had something similar. Fwiw, https://github.com/pappasam/toml-sort/tree/b9b6210da457c38122995e434b314f4c4a4a923e#configuration-file has an example config, but it doesn't document if it's the "default" config.

Proposal

The request here is to add example config(s) somewhere to docs/

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

1 participant