search

adrienverge / yamllint

A linter for YAML files.
GNU General Public License v3.0
2.9k stars 278 forks source link

docs: Import 'yamllint.config' rather than 'yamllint' #699

Closed adrienverge closed 3 days ago

adrienverge commented 1 week ago

Since yamllint version 0.5.2 (in 2016, just after yamllint was created) this example in documentation doesn't work. Indeed, commit dbbecb5 (which aimed to solve another problem) removed the ability to import yamllint submodules directly.

This commit makes it clearer inside documentation.

Fixes https://github.com/adrienverge/yamllint/issues/698

coveralls commented 1 week ago

Coverage Status

coverage: 99.825%. remained the same when pulling a079b63904c27983da402c276a00d5de205e460b on docs/fix-import-config into 95e17b33dc147c9c35742853e17bdf3fd508550b on master.