From 2f75e92a663eac41cbe74a0983fa8eb8090f6b42 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adrien=20Verg=C3=A9?= Date: Fri, 19 Feb 2016 09:29:05 +0100 Subject: [PATCH] Doc: Add a configuration example in README --- README.rst | 16 ++++++++++++++++ docs/configuration.rst | 2 +- 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index b54604a..24816c2 100644 --- a/README.rst +++ b/README.rst @@ -64,3 +64,19 @@ Usage # Output a parsable format (for syntax checking in editors like Vim, emacs...) yamllint -f parsable file.yml + +Configuration example +^^^^^^^^^^^^^^^^^^^^^ + +.. code:: yaml + + extends: default + + rules: + # 80 chars should be enough, but don't fail if a line is longer + line-length: + max: 80 + level: warning + + # don't bother me with this rule + indentation: disable diff --git a/docs/configuration.rst b/docs/configuration.rst index ec60111..419806c 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -50,7 +50,7 @@ strict on block sequences indentation: extends: default rules: - # 80 should be enough, but don't fail if a line is longer + # 80 chars should be enough, but don't fail if a line is longer line-length: max: 80 level: warning