0eb310e102
Implement problem report disabling with comments in YAML source, for
instance:
# The following mapping contains the same key twice,
# but I know what I'm doing:
key: value 1
key: value 2 # yamllint disable-line rule:key-duplicates
or:
# yamllint disable rule:colons
- Lorem : ipsum
dolor : sit amet,
consectetur : adipiscing elit
# yamllint enable rule:colons
Closes: #8
29 lines
443 B
ReStructuredText
29 lines
443 B
ReStructuredText
yamllint documentation
|
|
======================
|
|
|
|
.. automodule:: yamllint
|
|
|
|
Screenshot
|
|
----------
|
|
|
|
.. image:: screenshot.png
|
|
:alt: yamllint screenshot
|
|
|
|
.. note::
|
|
|
|
The default output format is inspired by `eslint <http://eslint.org/>`_, a
|
|
great linting tool for Javascript.
|
|
|
|
Table of contents
|
|
-----------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
quickstart
|
|
configuration
|
|
rules
|
|
disable_with_comments
|
|
development
|
|
text_editors
|