warpnet / salt-lint

A command-line utility that checks for best practices in SaltStack.
https://salt-lint.readthedocs.io/en/latest/
MIT License
152 stars 39 forks source link

Documentation inconsistency #311

Closed nf-brentsaner closed 9 months ago

nf-brentsaner commented 11 months ago

Describe the bug Two main bugs:

1.) The syntax and structure of the config file is not defined anywhere whatsoever. 2.) In the man page, the default configuration file is defined as .saltlint. (./.saltlint, ~/.saltlint, etc.). This is incorrect. The function checks for a .salt-lint, which a hyphen. (in fact, the only place .saltlint is mentioned anywhere in the repo is in that man page).

To Reproduce N/A

Expected behavior Documentation is complete and accurate.

Screenshots N/A

Desktop (please complete the following information):

N/A

Additional context N/A