yamllint version 0.5.1

The `pyyaml` dependency is needed in `install_requires` but also in
`setup_requires`, because running `setup.py` requires importing
`yamllint`, which itself imports `yaml`.

.gitignore

@@ -1,2 +1,3 @@
 __pycache__
 *.py[cod]
+/docs/_build

README.md

@@ -1,70 +0,0 @@
-# yamllint
-
-A linter for YAML files.
-
-[![Build Status](https://travis-ci.org/adrienverge/yamllint.svg?branch=master)](https://travis-ci.org/adrienverge/yamllint)
-[![Coverage Status](https://coveralls.io/repos/adrienverge/yamllint/badge.svg?branch=master&service=github)](https://coveralls.io/github/adrienverge/yamllint?branch=master)
-
-Compatible with Python 2 & 3.
-
-## Usage
-
-```sh
-yamllint my_file.yml my_other_file.yaml ...
-```
-
-```sh
-yamllint .
-```
-
-```sh
-yamllint -c ~/myconfig file.yml
-```
-
-```sh
-# To output a format parsable (by editors like Vim, emacs, etc.)
-yamllint -f parsable file.yml
-```
-
-## Installation
-
-```sh
-pip install yamllint
-```
-
-## Configuration
-
-There is no documentation yet, so here is what you need to know: you can
-override some rules, disable them or pass them in *warning* (instead of
-*error*). Have a look at the content of `yamllint/conf/default.yml` and create
-your own configuration file.
-
-It could look like this:
-
-```yaml
-# This is my first, very own configuration file for yamllint!
-# It extends the default conf by adjusting some options.
-
-extends: default
-
-rules:
-  # 80 should be enough, but don't fail if a line is longer
-  line-length:
-    max: 80
-    level: warning
-
-  # accept both
-  #    key:
-  #      - item
-  # and
-  #    key:
-  #    - item
-  indentation:
-    indent-sequences: whatever
-
-  # don't bother me with this rule
-  comments-indentation: disable
-```
-
-Tip: if you have a `.yamllint` file in your working directory, it will be
-automatically loaded as configuration by yamllint.

README.rst

@@ -0,0 +1,62 @@
+yamllint
+========
+
+A linter for YAML files.
+
+.. image::
+   https://travis-ci.org/adrienverge/yamllint.svg?branch=master
+   :target: https://travis-ci.org/adrienverge/yamllint
+   :alt: CI tests status
+.. image::
+   https://coveralls.io/repos/github/adrienverge/yamllint/badge.svg?branch=master
+   :target: https://coveralls.io/github/adrienverge/yamllint?branch=master
+   :alt: Code coverage status
+.. image:: https://readthedocs.org/projects/yamllint/badge/?version=latest
+   :target: http://yamllint.readthedocs.org/en/latest/?badge=latest
+   :alt: Documentation status
+
+Written in Python (compatible with Python 2 & 3).
+
+Documentation
+-------------
+
+http://yamllint.readthedocs.org/
+
+Short overview
+--------------
+
+Screenshot
+^^^^^^^^^^
+
+.. image:: docs/screenshot.png
+   :alt: yamllint screenshot
+
+Installation
+^^^^^^^^^^^^
+
+.. code:: bash
+
+ pip install yamllint
+
+Usage
+^^^^^
+
+.. code:: bash
+
+ # Lint one or more files
+ yamllint my_file.yml my_other_file.yaml ...
+
+.. code:: bash
+
+ # Lint all YAML files in a directory
+ yamllint .
+
+.. code:: bash
+
+ # Use a custom lint configuration
+ yamllint -c ~/myconfig file.yml
+
+.. code:: bash
+
+ # Output a parsable format (for syntax checking in editors like Vim, emacs...)
+ yamllint -f parsable file.yml

docs/Makefile

@@ -0,0 +1,177 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/yamllint.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/yamllint.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/yamllint"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/yamllint"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

docs/conf.py

@@ -0,0 +1,43 @@
+# -*- coding: utf-8 -*-
+# yamllint documentation build configuration file, created by
+# sphinx-quickstart on Thu Jan 21 21:18:52 2016.
+
+import sys
+import os
+
+sys.path.insert(0, os.path.abspath('..'))  # noqa
+
+from yamllint import __copyright__, APP_NAME, APP_VERSION
+
+# -- General configuration ------------------------------------------------
+
+extensions = [
+    'sphinx.ext.autodoc',
+]
+
+source_suffix = '.rst'
+
+master_doc = 'index'
+
+project = APP_NAME
+copyright = __copyright__
+
+version = APP_VERSION
+release = APP_VERSION
+
+pygments_style = 'sphinx'
+
+# -- Options for HTML output ----------------------------------------------
+
+html_theme = 'default'
+
+htmlhelp_basename = 'yamllintdoc'
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'yamllint', u'yamllint Documentation',
+     [u'Adrien Vergé'], 1)
+]

docs/configuration.rst

@@ -0,0 +1,74 @@
+Configuration
+=============
+
+yamllint uses a set of *rules* to check sources files for problems. Each rule is
+independent from the others, and can be enabled, disabled or tweaked. All these
+settings can be gathered in a configuration file.
+
+To use a custom configuration file, either name it ``.yamllint`` in your working
+directory, or use the ``-c`` option:
+
+::
+
+ yamllint -c ~/myconfig file.yml
+
+Default configuration
+---------------------
+
+Unless told otherwise, yamllint uses its ``default`` configuration:
+
+.. literalinclude:: ../yamllint/conf/default.yml
+   :language: yaml
+
+Details on rules can be found on :doc:`the rules page <rules>`.
+
+Extending the default configuration
+-----------------------------------
+
+When writing a custom configuration file, you don't need to redefine every rule.
+Just extend the ``default`` configuration (or any already-existing configuration
+file).
+
+For instance, if you just want to disable the ``comments-indentation`` rule,
+your file could look like this:
+
+.. code-block:: yaml
+
+ # This is my first, very own configuration file for yamllint!
+ # It extends the default conf by adjusting some options.
+
+ extends: default
+
+ rules:
+   comments-indentation: disable  # don't bother me with this rule
+
+Similarly, if you want to set the ``line-length`` rule as a warning and be less
+strict on block sequences indentation:
+
+.. code-block:: yaml
+
+ extends: default
+
+ rules:
+   # 80 should be enough, but don't fail if a line is longer
+   line-length:
+     max: 80
+     level: warning
+
+   # accept both     key:
+   #                   - item
+   #
+   # and             key:
+   #                 - item
+   indentation:
+     indent-sequences: whatever
+
+Errors and warnings
+-------------------
+
+Problems detected by yamllint can be raised either as errors or as warnings.
+
+In both cases, the script will output them (with different colors when using the
+``standard`` output format), but the exit code can be different. More precisely,
+the script will exit will a failure code *only when* there is one or more
+error(s).

docs/development.rst

@@ -0,0 +1,11 @@
+Development
+===========
+
+yamllint provides both a script and a Python module. The latter can be used to
+write your own linting tools:
+
+.. autoclass:: yamllint.errors.LintProblem
+   :members:
+
+.. automodule:: yamllint
+   :members:

docs/index.rst

@@ -0,0 +1,27 @@
+yamllint documentation
+======================
+
+A linter for YAML files.
+
+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
+   development
+   text_editors

docs/quickstart.rst

@@ -0,0 +1,72 @@
+Quickstart
+==========
+
+Installing yamllint
+-------------------
+
+First, install yamllint. The easiest way is to use pip, the Python package
+manager:
+
+::
+
+ sudo pip install yamllint
+
+If you prefer installing from source, you can run, from the source directory:
+
+::
+
+ python setup.py sdist
+ sudo pip install dist/yamllint-*.tar.gz
+
+Running yamllint
+----------------
+
+Basic usage:
+
+::
+
+ yamllint file.yml other-file.yaml
+
+You can also lint all YAML files in a whole directory:
+
+::
+
+ yamllint .
+
+The output will look like (colors are not displayed here):
+
+::
+
+ file.yml
+   6:2       warning  missing starting space in comment  (comments)
+   57:1      error    trailing spaces  (trailing-spaces)
+   60:3      error    wrong indentation: expected 4 but found 2  (indentation)
+
+ other-file.yml
+   1:1       warning  missing document start "---"  (document-start)
+   9:81      error    line too long (84 > 80 characters)  (line-length)
+   31:1      error    too many blank lines (4 > 2)  (empty-lines)
+   37:12     error    too many spaces inside braces  (braces)
+
+Add the ``-f parsable`` arguments if you need an output format parsable by a
+machine (for instance for :doc:`syntax highlighting in text editors
+<text_editors>`). The output will then look like:
+
+::
+
+ file.yml:6:2: [warning] missing starting space in comment (comments)
+ file.yml:57:1: [error] trailing spaces (trailing-spaces)
+ file.yml:60:3: [error] wrong indentation: expected 4 but found 2 (indentation)
+
+If you have a custom linting configuration file (see :doc:`how to configure
+yamllint <configuration>`), it can be passed to yamllint using the ``-c``
+option:
+
+::
+
+ yamllint -c ~/myconfig file.yml
+
+.. note::
+
+   If you have a ``.yamllint`` file in your working directory, it will be
+   automatically loaded as configuration by yamllint.

docs/rules.rst

@@ -0,0 +1,90 @@
+Rules
+=====
+
+When linting a document with yamllint, a series of rules (such as
+``line-length``, ``trailing-spaces``, etc.) are checked against.
+
+A :doc:`configuration file <configuration>` can be used to enable or disable
+these rules, to set their level (*error* or *warning*), but also to tweak their
+options.
+
+This page describes the rules and their options.
+
+.. contents:: List of rules
+   :local:
+   :depth: 1
+
+braces
+------
+
+.. automodule:: yamllint.rules.braces
+
+brackets
+--------
+
+.. automodule:: yamllint.rules.brackets
+
+colons
+------
+
+.. automodule:: yamllint.rules.colons
+
+commas
+------
+
+.. automodule:: yamllint.rules.commas
+
+comments
+--------
+
+.. automodule:: yamllint.rules.comments
+
+comments-indentation
+--------------------
+
+.. automodule:: yamllint.rules.comments_indentation
+
+document-end
+------------
+
+.. automodule:: yamllint.rules.document_end
+
+document-start
+--------------
+
+.. automodule:: yamllint.rules.document_start
+
+empty-lines
+-----------
+
+.. automodule:: yamllint.rules.empty_lines
+
+hyphens
+-------
+
+.. automodule:: yamllint.rules.hyphens
+
+indentation
+-----------
+
+.. automodule:: yamllint.rules.indentation
+
+line-length
+-----------
+
+.. automodule:: yamllint.rules.line_length
+
+new-line-at-end-of-file
+-----------------------
+
+.. automodule:: yamllint.rules.new_line_at_end_of_file
+
+new-lines
+---------
+
+.. automodule:: yamllint.rules.new_lines
+
+trailing-spaces
+---------------
+
+.. automodule:: yamllint.rules.trailing_spaces

docs/text_editors.rst

@@ -0,0 +1,40 @@
+Integration with text editors
+=============================
+
+Most text editors support syntax checking and highlighting, to visually report
+syntax errors and warnings to the user. yamllint can be used to syntax-check
+YAML source, but a bit of configuration is required depending on your favorite
+text editor.
+
+Vim
+---
+
+Assuming that the `syntastic <https://github.com/scrooloose/syntastic>`_ plugin
+is installed, add to your ``.vimrc``:
+
+::
+
+ TODO
+
+Neovim
+------
+
+Assuming that the `neomake <https://github.com/benekastah/neomake>`_ plugin is
+installed, add to your ``.config/nvim/init.vim``:
+
+::
+
+ if executable('yamllint')
+   let g:neomake_yaml_yamllint_maker = {
+     \ 'args': ['-f', 'parsable'],
+     \ 'errorformat': '%E%f:%l:%c: [error] %m,%W%f:%l:%c: [warning] %m' }
+   let g:neomake_yaml_enabled_makers = ['yamllint']
+ endif
+
+Other text editors
+------------------
+
+.. rubric:: Help wanted!
+
+Your favorite text editor is not listed here? Help us improve by adding a
+section (by opening a pull-request or issue on GitHub).

setup.py

@@ -26,7 +26,7 @@ setup(
     author=__author__,
     description=APP_DESCRIPTION,
     license=__license__,
-    keywords=['yaml', 'lint', 'linter'],
+    keywords=['yaml', 'lint', 'linter', 'syntax', 'checker'],
     url='https://github.com/adrienverge/yamllint',
     classifiers=[
         'Development Status :: 4 - Beta',
@@ -45,6 +45,8 @@ setup(
     scripts=['bin/yamllint'],
     package_data={'yamllint': ['conf/*.yml']},
     install_requires=['pyyaml'],
+    setup_requires=['pyyaml'],  # importing `yamllint` (for APP_NAME etc.)
+                                # requires importing `yaml`
     tests_require=['nose'],
     test_suite='nose.collector',
 )

tests/rules/test_indentation.py

@@ -494,60 +494,116 @@ class ScalarIndentationTestCase(RuleTestCase):
     rule_id = 'indentation'
 
     def test_basics_plain(self):
-        conf = ('indentation: {spaces: 2}\n'
+        conf = ('indentation: {spaces: 2, check-multi-line-strings: no}\n'
                 'document-start: disable\n')
         self.check('multi\n'
                    'line\n', conf)
         self.check('multi\n'
-                   ' line\n', conf, problem=(2, 2))
+                   ' line\n', conf)
         self.check('- multi\n'
                    '  line\n', conf)
         self.check('- multi\n'
-                   '   line\n', conf, problem=(2, 4))
+                   '   line\n', conf)
         self.check('a key: multi\n'
                    '       line\n', conf)
+        self.check('a key: multi\n'
+                   '  line\n', conf, problem=(2, 3))
+        self.check('a key: multi\n'
+                   '        line\n', conf)
+        self.check('a key:\n'
+                   '  multi\n'
+                   '  line\n', conf)
+        self.check('- C code: void main() {\n'
+                   '              printf("foo");\n'
+                   '          }\n', conf)
+        self.check('- C code:\n'
+                   '    void main() {\n'
+                   '        printf("foo");\n'
+                   '    }\n', conf)
+
+    def test_check_multi_line_plain(self):
+        conf = ('indentation: {spaces: 2, check-multi-line-strings: yes}\n'
+                'document-start: disable\n')
+        self.check('multi\n'
+                   ' line\n', conf, problem=(2, 2))
+        self.check('- multi\n'
+                   '   line\n', conf, problem=(2, 4))
         self.check('a key: multi\n'
                    '        line\n', conf, problem=(2, 9))
-        self.check('a key:\n'
-                   '  multi\n'
-                   '  line\n', conf)
         self.check('a key:\n'
                    '  multi\n'
                    '   line\n', conf, problem=(3, 4))
+        self.check('- C code: void main() {\n'
+                   '              printf("foo");\n'
+                   '          }\n', conf, problem=(2, 15))
+        self.check('- C code:\n'
+                   '    void main() {\n'
+                   '        printf("foo");\n'
+                   '    }\n', conf, problem=(3, 9))
 
     def test_basics_quoted(self):
-        conf = ('indentation: {spaces: 2}\n'
+        conf = ('indentation: {spaces: 2, check-multi-line-strings: no}\n'
                 'document-start: disable\n')
         self.check('"multi\n'
                    ' line"\n', conf)
         self.check('"multi\n'
                    'line"\n', conf, problem=(2, 1))
-        self.check('"multi\n'
-                   '  line"\n', conf, problem=(2, 3))
         self.check('- "multi\n'
                    '   line"\n', conf)
         self.check('- "multi\n'
                    '  line"\n', conf, problem=(2, 3))
-        self.check('- "multi\n'
-                   '    line"\n', conf, problem=(2, 5))
         self.check('a key: "multi\n'
                    '        line"\n', conf)
         self.check('a key: "multi\n'
-                   '       line"\n', conf, problem=(2, 8))
+                   '  line"\n', conf, problem=(2, 3))
         self.check('a key: "multi\n'
-                   '         line"\n', conf, problem=(2, 10))
+                   '       line"\n', conf, problem=(2, 8))
         self.check('a key:\n'
                    '  "multi\n'
                    '   line"\n', conf)
         self.check('a key:\n'
                    '  "multi\n'
                    '  line"\n', conf, problem=(3, 3))
+        self.check('- jinja2: "{% if ansible is defined %}\n'
+                   '             {{ ansible }}\n'
+                   '           {% else %}\n'
+                   '             {{ chef }}\n'
+                   '           {% endif %}"\n', conf)
+        self.check('- jinja2:\n'
+                   '    "{% if ansible is defined %}\n'
+                   '       {{ ansible }}\n'
+                   '     {% else %}\n'
+                   '       {{ chef }}\n'
+                   '     {% endif %}"\n', conf)
+
+    def test_check_multi_line_quoted(self):
+        conf = ('indentation: {spaces: 2, check-multi-line-strings: yes}\n'
+                'document-start: disable\n')
+        self.check('"multi\n'
+                   '  line"\n', conf, problem=(2, 3))
+        self.check('- "multi\n'
+                   '    line"\n', conf, problem=(2, 5))
+        self.check('a key: "multi\n'
+                   '         line"\n', conf, problem=(2, 10))
         self.check('a key:\n'
                    '  "multi\n'
                    '    line"\n', conf, problem=(3, 5))
+        self.check('- jinja2: "{% if ansible is defined %}\n'
+                   '             {{ ansible }}\n'
+                   '           {% else %}\n'
+                   '             {{ chef }}\n'
+                   '           {% endif %}"\n', conf,
+                   problem1=(2, 14), problem2=(4, 14))
+        self.check('- jinja2:\n'
+                   '    "{% if ansible is defined %}\n'
+                   '       {{ ansible }}\n'
+                   '     {% else %}\n'
+                   '       {{ chef }}\n'
+                   '     {% endif %}"\n', conf,
+                   problem1=(3, 8), problem2=(5, 8))
 
     def test_basics_folded_style(self):
-        conf = ('indentation: {spaces: 2}\n'
+        conf = ('indentation: {spaces: 2, check-multi-line-strings: no}\n'
                 'document-start: disable\n')
         self.check('>\n'
                    '  multi\n'
@@ -576,9 +632,55 @@ class ScalarIndentationTestCase(RuleTestCase):
                    '    >\n'
                    '      multi-line\n'
                    '      value\n', conf)
+        self.check('- jinja2: >\n'
+                   '    {% if ansible is defined %}\n'
+                   '      {{ ansible }}\n'
+                   '    {% else %}\n'
+                   '      {{ chef }}\n'
+                   '    {% endif %}\n', conf)
+
+    def test_check_multi_line_folded_style(self):
+        conf = ('indentation: {spaces: 2, check-multi-line-strings: yes}\n'
+                'document-start: disable\n')
+        self.check('>\n'
+                   '  multi\n'
+                   '   line\n', conf, problem=(3, 4))
+        self.check('- >\n'
+                   '    multi\n'
+                   '     line\n', conf, problem=(3, 6))
+        self.check('- key: >\n'
+                   '    multi\n'
+                   '     line\n', conf, problem=(3, 6))
+        self.check('- key:\n'
+                   '    >\n'
+                   '      multi\n'
+                   '       line\n', conf, problem=(4, 8))
+        self.check('- ? >\n'
+                   '      multi-line\n'
+                   '       key\n'
+                   '  : >\n'
+                   '      multi-line\n'
+                   '       value\n', conf,
+                   problem1=(3, 8), problem2=(6, 8))
+        self.check('- ?\n'
+                   '    >\n'
+                   '      multi-line\n'
+                   '       key\n'
+                   '  :\n'
+                   '    >\n'
+                   '      multi-line\n'
+                   '       value\n', conf,
+                   problem1=(4, 8), problem2=(8, 8))
+        self.check('- jinja2: >\n'
+                   '    {% if ansible is defined %}\n'
+                   '      {{ ansible }}\n'
+                   '    {% else %}\n'
+                   '      {{ chef }}\n'
+                   '    {% endif %}\n', conf,
+                   problem1=(3, 7), problem2=(5, 7))
 
     def test_basics_literal_style(self):
-        conf = ('indentation: {spaces: 2}\n'
+        conf = ('indentation: {spaces: 2, check-multi-line-strings: no}\n'
                 'document-start: disable\n')
         self.check('|\n'
                    '  multi\n'
@@ -607,12 +709,58 @@ class ScalarIndentationTestCase(RuleTestCase):
                    '    |\n'
                    '      multi-line\n'
                    '      value\n', conf)
+        self.check('- jinja2: |\n'
+                   '    {% if ansible is defined %}\n'
+                   '     {{ ansible }}\n'
+                   '    {% else %}\n'
+                   '      {{ chef }}\n'
+                   '    {% endif %}\n', conf)
+
+    def test_check_multi_line_literal_style(self):
+        conf = ('indentation: {spaces: 2, check-multi-line-strings: yes}\n'
+                'document-start: disable\n')
+        self.check('|\n'
+                   '  multi\n'
+                   '   line\n', conf, problem=(3, 4))
+        self.check('- |\n'
+                   '    multi\n'
+                   '     line\n', conf, problem=(3, 6))
+        self.check('- key: |\n'
+                   '    multi\n'
+                   '     line\n', conf, problem=(3, 6))
+        self.check('- key:\n'
+                   '    |\n'
+                   '      multi\n'
+                   '       line\n', conf, problem=(4, 8))
+        self.check('- ? |\n'
+                   '      multi-line\n'
+                   '       key\n'
+                   '  : |\n'
+                   '      multi-line\n'
+                   '       value\n', conf,
+                   problem1=(3, 8), problem2=(6, 8))
+        self.check('- ?\n'
+                   '    |\n'
+                   '      multi-line\n'
+                   '       key\n'
+                   '  :\n'
+                   '    |\n'
+                   '      multi-line\n'
+                   '       value\n', conf,
+                   problem1=(4, 8), problem2=(8, 8))
+        self.check('- jinja2: |\n'
+                   '    {% if ansible is defined %}\n'
+                   '      {{ ansible }}\n'
+                   '    {% else %}\n'
+                   '      {{ chef }}\n'
+                   '    {% endif %}\n', conf,
+                   problem1=(3, 7), problem2=(5, 7))
 
     # The following "paragraph" examples are inspired from
     # http://stackoverflow.com/questions/3790454/in-yaml-how-do-i-break-a-string-over-multiple-lines
 
     def test_paragraph_plain(self):
-        conf = ('indentation: {spaces: 2}\n'
+        conf = ('indentation: {spaces: 2, check-multi-line-strings: yes}\n'
                 'document-start: disable\n')
         self.check('- long text: very "long"\n'
                    '             \'string\' with\n'
@@ -633,7 +781,7 @@ class ScalarIndentationTestCase(RuleTestCase):
                    '    spaces.\n', conf)
 
     def test_paragraph_double_quoted(self):
-        conf = ('indentation: {spaces: 2}\n'
+        conf = ('indentation: {spaces: 2, check-multi-line-strings: yes}\n'
                 'document-start: disable\n')
         self.check('- long text: "very \\"long\\"\n'
                    '              \'string\' with\n'
@@ -660,7 +808,7 @@ class ScalarIndentationTestCase(RuleTestCase):
                    '     spaces."\n', conf)
 
     def test_paragraph_single_quoted(self):
-        conf = ('indentation: {spaces: 2}\n'
+        conf = ('indentation: {spaces: 2, check-multi-line-strings: yes}\n'
                 'document-start: disable\n')
         self.check('- long text: \'very "long"\n'
                    '              \'\'string\'\' with\n'
@@ -687,7 +835,7 @@ class ScalarIndentationTestCase(RuleTestCase):
                    '     spaces.\'\n', conf)
 
     def test_paragraph_folded(self):
-        conf = ('indentation: {spaces: 2}\n'
+        conf = ('indentation: {spaces: 2, check-multi-line-strings: yes}\n'
                 'document-start: disable\n')
         self.check('- long text: >\n'
                    '    very "long"\n'
@@ -704,7 +852,7 @@ class ScalarIndentationTestCase(RuleTestCase):
                    problem1=(3, 6), problem2=(5, 7), problem3=(6, 8))
 
     def test_paragraph_literal(self):
-        conf = ('indentation: {spaces: 2}\n'
+        conf = ('indentation: {spaces: 2, check-multi-line-strings: yes}\n'
                 'document-start: disable\n')
         self.check('- long text: |\n'
                    '    very "long"\n'

yamllint/__init__.py

@@ -22,11 +22,11 @@ from yamllint import parser
 
 
 APP_NAME = 'yamllint'
-APP_VERSION = '0.4.0'
+APP_VERSION = '0.5.1'
 APP_DESCRIPTION = 'A linter for YAML files.'
 
-__author__ = 'Adrien Vergé'
+__author__ = u'Adrien Vergé'
-__copyright__ = 'Copyright 2016, Adrien Vergé'
+__copyright__ = u'Copyright 2016, Adrien Vergé'
 __license__ = 'GPLv3'
 __version__ = APP_VERSION
 

yamllint/conf/default.yml

@@ -32,6 +32,7 @@ rules:
   indentation:
     spaces: 2
     indent-sequences: yes
+    check-multi-line-strings: no
   line-length:
     max: 80
   new-line-at-end-of-file: {level: error}

yamllint/errors.py

@@ -16,10 +16,15 @@
 
 
 class LintProblem(object):
+    """Represents a linting problem found by yamllint."""
     def __init__(self, line, column, desc='<no description>', rule=None):
+        #: Line on which the problem was found (starting at 1)
         self.line = line
+        #: Column on which the problem was found (starting at 1)
         self.column = column
+        #: Human-readable description of the problem
         self.desc = desc
+        #: Identifier of the rule that detected the problem
         self.rule = rule
         self.level = None
 

yamllint/rules/braces.py

@@ -14,6 +14,54 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+"""
+Use this rule to control the number of spaces inside braces (``{`` and ``}``).
+
+.. rubric:: Options
+
+* ``min-spaces-inside`` defines the minimal number of spaces required inside
+  braces.
+* ``max-spaces-inside`` defines the maximal number of spaces allowed inside
+  braces.
+
+.. rubric:: Examples
+
+#. With ``braces: {min-spaces-inside: 0, max-spaces-inside: 0}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    object: {key1: 4, key2: 8}
+
+   the following code snippet would **FAIL**:
+   ::
+
+    object: { key1: 4, key2: 8 }
+
+#. With ``braces: {min-spaces-inside: 1, max-spaces-inside: 3}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    object: { key1: 4, key2: 8 }
+
+   the following code snippet would **PASS**:
+   ::
+
+    object: { key1: 4, key2: 8   }
+
+   the following code snippet would **FAIL**:
+   ::
+
+    object: {    key1: 4, key2: 8   }
+
+   the following code snippet would **FAIL**:
+   ::
+
+    object: {key1: 4, key2: 8 }
+"""
+
+
 import yaml
 
 from yamllint.rules.common import spaces_after, spaces_before

yamllint/rules/brackets.py

@@ -14,6 +14,55 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+"""
+Use this rule to control the number of spaces inside brackets (``[`` and
+``]``).
+
+.. rubric:: Options
+
+* ``min-spaces-inside`` defines the minimal number of spaces required inside
+  brackets.
+* ``max-spaces-inside`` defines the maximal number of spaces allowed inside
+  brackets.
+
+.. rubric:: Examples
+
+#. With ``brackets: {min-spaces-inside: 0, max-spaces-inside: 0}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    object: [1, 2, abc]
+
+   the following code snippet would **FAIL**:
+   ::
+
+    object: [ 1, 2, abc ]
+
+#. With ``brackets: {min-spaces-inside: 1, max-spaces-inside: 3}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    object: [ 1, 2, abc ]
+
+   the following code snippet would **PASS**:
+   ::
+
+    object: [ 1, 2, abc   ]
+
+   the following code snippet would **FAIL**:
+   ::
+
+    object: [    1, 2, abc   ]
+
+   the following code snippet would **FAIL**:
+   ::
+
+    object: [1, 2, abc ]
+"""
+
+
 import yaml
 
 from yamllint.rules.common import spaces_after, spaces_before

yamllint/rules/colons.py

@@ -14,6 +14,62 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+"""
+Use this rule to control the number of spaces before and after colons (``:``).
+
+.. rubric:: Options
+
+* ``max-spaces-before`` defines the maximal number of spaces allowed before
+  colons (use ``-1`` to disable).
+* ``max-spaces-after`` defines the maximal number of spaces allowed after
+  colons (use ``-1`` to disable).
+
+.. rubric:: Examples
+
+#. With ``colons: {max-spaces-before: 0, max-spaces-after: 1}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    object:
+      - a
+      - b
+    key: value
+
+#. With ``colons: {max-spaces-before: 1}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    object :
+      - a
+      - b
+
+   the following code snippet would **FAIL**:
+   ::
+
+    object  :
+      - a
+      - b
+
+#. With ``colons: {max-spaces-after: 2}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    first:  1
+    second: 2
+    third:  3
+
+   the following code snippet would **FAIL**:
+   ::
+
+    first: 1
+    2nd:   2
+    third: 3
+"""
+
+
 import yaml
 
 from yamllint.rules.common import spaces_after, spaces_before, is_explicit_key

yamllint/rules/commas.py

@@ -14,6 +14,54 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+"""
+Use this rule to control the number of spaces before and after commas (``,``).
+
+.. rubric:: Options
+
+* ``max-spaces-before`` defines the maximal number of spaces allowed before
+  commas (use ``-1`` to disable).
+* ``max-spaces-after`` defines the maximal number of spaces allowed after
+  commas (use ``-1`` to disable).
+
+.. rubric:: Examples
+
+#. With ``commas: {max-spaces-before: 0, max-spaces-after: 1}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    strange var:
+      [10, 20, 30, {x: 1, y: 2}]
+
+   the following code snippet would **FAIL**:
+   ::
+
+    strange var:
+      [10, 20 , 30, {x: 1, y: 2}]
+
+   the following code snippet would **FAIL**:
+   ::
+
+    strange var:
+      [10, 20, 30, {x: 1,  y: 2}]
+
+#. With ``commas: {max-spaces-before: 2, max-spaces-after: 2}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    strange var:
+      [10  , 20 ,  30,  {x: 1  ,  y: 2}]
+
+   the following code snippet would **FAIL**:
+   ::
+
+    strange var:
+      [10  , 20 ,   30,  {x: 1  ,  y: 2}]
+"""
+
+
 import yaml
 
 from yamllint.errors import LintProblem

yamllint/rules/comments.py

@@ -14,6 +14,47 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+"""
+Use this rule to control the position and formatting of comments.
+
+.. rubric:: Options
+
+* Use ``require-starting-space`` to require a space character right after the
+  ``#``. Set to ``yes`` to enable, ``no`` to disable.
+* ``min-spaces-from-content`` is used to visually separate inline comments from
+  content. It defines the minimal required number of spaces between a comment
+  and its preceding content.
+
+.. rubric:: Examples
+
+#. With ``comments: {require-starting-space: yes}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    # This sentence
+    # is a block comment
+
+   the following code snippet would **FAIL**:
+   ::
+
+    #This sentence
+    #is a block comment
+
+#. With ``comments: {min-spaces-from-content: 2}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    x = 2 ^ 127 - 1  # Mersenne prime number
+
+   the following code snippet would **FAIL**:
+   ::
+
+    x = 2 ^ 127 - 1 # Mersenne prime number
+"""
+
+
 import yaml
 
 from yamllint.errors import LintProblem

yamllint/rules/comments_indentation.py

@@ -14,6 +14,67 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+"""
+Use this rule to force comments to be indented like content.
+
+.. rubric:: Examples
+
+#. With ``comments-indentation: {}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    # Fibonacci
+    [0, 1, 1, 2, 3, 5]
+
+   the following code snippet would **FAIL**:
+   ::
+
+      # Fibonacci
+    [0, 1, 1, 2, 3, 5]
+
+   the following code snippet would **PASS**:
+   ::
+
+    list:
+        - 2
+        - 3
+        # - 4
+        - 5
+
+   the following code snippet would **FAIL**:
+   ::
+
+    list:
+        - 2
+        - 3
+    #    - 4
+        - 5
+
+   the following code snippet would **PASS**:
+   ::
+
+    # This is the first object
+    obj1:
+      - item A
+      # - item B
+    # This is the second object
+    obj2: []
+
+   the following code snippet would **PASS**:
+   ::
+
+    # This sentence
+    # is a block comment
+
+   the following code snippet would **FAIL**:
+   ::
+
+    # This sentence
+     # is a block comment
+"""
+
+
 import yaml
 
 from yamllint.errors import LintProblem

yamllint/rules/document_end.py

@@ -14,6 +14,66 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+"""
+Use this rule to require or forbid the use of document end marker (``...``).
+
+.. rubric:: Options
+
+* Set ``present`` to ``yes`` when the document end marker is required, or to
+  ``no`` when it is forbidden.
+
+.. rubric:: Examples
+
+#. With ``document-end: {present: yes}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    ---
+    this:
+      is: [a, document]
+    ...
+    ---
+    - this
+    - is: another one
+    ...
+
+   the following code snippet would **FAIL**:
+   ::
+
+    ---
+    this:
+      is: [a, document]
+    ---
+    - this
+    - is: another one
+    ...
+
+#. With ``document-end: {present: no}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    ---
+    this:
+      is: [a, document]
+    ---
+    - this
+    - is: another one
+
+   the following code snippet would **FAIL**:
+   ::
+
+    ---
+    this:
+      is: [a, document]
+    ...
+    ---
+    - this
+    - is: another one
+"""
+
+
 import yaml
 
 from yamllint.errors import LintProblem

yamllint/rules/document_start.py

@@ -14,6 +14,56 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+"""
+Use this rule to require or forbid the use of document start marker (``---``).
+
+.. rubric:: Options
+
+* Set ``present`` to ``yes`` when the document start marker is required, or to
+  ``no`` when it is forbidden.
+
+.. rubric:: Examples
+
+#. With ``document-start: {present: yes}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    ---
+    this:
+      is: [a, document]
+    ---
+    - this
+    - is: another one
+
+   the following code snippet would **FAIL**:
+   ::
+
+    this:
+      is: [a, document]
+    ---
+    - this
+    - is: another one
+
+#. With ``document-start: {present: no}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    this:
+      is: [a, document]
+    ...
+
+   the following code snippet would **FAIL**:
+   ::
+
+    ---
+    this:
+      is: [a, document]
+    ...
+"""
+
+
 import yaml
 
 from yamllint.errors import LintProblem

yamllint/rules/empty_lines.py

@@ -14,6 +14,42 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+"""
+Use this rule to set a maximal number of allowed consecutive blank lines.
+
+.. rubric:: Options
+
+* ``max`` defines the maximal number of empty lines allowed in the document.
+* ``max-start`` defines the maximal number of empty lines allowed at the
+  beginning of the file. This option takes precedence over ``max``.
+* ``max-end`` defines the maximal number of empty lines allowed at the end of
+  the file.  This option takes precedence over ``max``.
+
+.. rubric:: Examples
+
+#. With ``empty-lines: {max: 1}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    - foo:
+        - 1
+        - 2
+
+    - bar: [3, 4]
+
+   the following code snippet would **FAIL**:
+   ::
+
+    - foo:
+        - 1
+        - 2
+
+
+    - bar: [3, 4]
+"""
+
+
 from yamllint.errors import LintProblem
 
 

yamllint/rules/hyphens.py

@@ -14,6 +14,60 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+"""
+Use this rule to control the number of spaces after hyphens (``-``).
+
+.. rubric:: Options
+
+* ``max-spaces-after`` defines the maximal number of spaces allowed after
+  hyphens.
+
+.. rubric:: Examples
+
+#. With ``hyphens: {max-spaces-after: 1}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    - first list:
+        - a
+        - b
+    - - 1
+      - 2
+      - 3
+
+   the following code snippet would **FAIL**:
+   ::
+
+    -  first list:
+         - a
+         - b
+
+   the following code snippet would **FAIL**:
+   ::
+
+    - - 1
+      -  2
+      - 3
+
+#. With ``hyphens: {max-spaces-after: 3}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    -   key
+    -  key2
+    - key42
+
+   the following code snippet would **FAIL**:
+   ::
+
+    -    key
+    -   key2
+    -  key42
+"""
+
+
 import yaml
 
 from yamllint.rules.common import spaces_after

yamllint/rules/indentation.py

@@ -14,6 +14,122 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+"""
+Use this rule to control the indentation.
+
+.. rubric:: Options
+
+* ``spaces`` defines the number of spaces that represent an indentation level.
+* ``indent-sequences`` defines whether block sequences should be indented or
+  not (when in a mapping, this indentation is not mandatory -- some people
+  perceive the ``-`` as part of the indentation). Possible values: ``yes``,
+  ``no`` and ``whatever`` (the latter means either indenting or not indenting
+  block sequences is OK.
+* ``check-multi-line-strings`` defines whether to lint indentation in
+  multi-line strings. Set to ``yes`` to enable, ``no`` to disable.
+
+.. rubric:: Examples
+
+#. With ``indentation: {spaces: 1}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    history:
+     - name: Unix
+       date: 1969
+     - name: Linux
+       date: 1991
+    nest:
+     recurse:
+      - haystack:
+         needle
+
+#. With ``indentation: {spaces: 4}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    history:
+        - name: Unix
+          date: 1969
+        - name: Linux
+          date: 1991
+    nest:
+        recurse:
+            - haystack:
+                  needle
+
+   the following code snippet would **FAIL**:
+   ::
+
+    history:
+      - name: Unix
+        date: 1969
+      - name: Linux
+        date: 1991
+    nest:
+      recurse:
+        - haystack:
+            needle
+
+#. With ``indentation: {spaces: 2, indent-sequences: no}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    list:
+    - flying
+    - spaghetti
+    - monster
+
+   the following code snippet would **FAIL**:
+   ::
+
+    list:
+      - flying
+      - spaghetti
+      - monster
+
+#. With ``indentation: {spaces: 2, indent-sequences: whatever}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    list:
+    - flying:
+      - spaghetti
+      - monster
+    - not flying:
+        - spaghetti
+        - sauce
+
+#. With ``indentation: {spaces: 4, check-multi-line-strings: yes}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    Blaise Pascal:
+        Je vous écris une longue lettre parce que
+        je n'ai pas le temps d'en écrire une courte.
+
+   the following code snippet would **FAIL**:
+   ::
+
+    C code:
+        void main() {
+            printf("foo");
+        }
+
+   the following code snippet would **PASS**:
+   ::
+
+    C code:
+        void main() {
+        printf("bar");
+        }
+"""
+
 import yaml
 
 from yamllint.errors import LintProblem
@@ -23,7 +139,8 @@ from yamllint.rules.common import is_explicit_key
 ID = 'indentation'
 TYPE = 'token'
 CONF = {'spaces': int,
-        'indent-sequences': (True, False, 'whatever')}
+        'indent-sequences': (True, False, 'whatever'),
+        'check-multi-line-strings': bool}
 
 ROOT, MAP, B_SEQ, F_SEQ, KEY, VAL = range(6)
 
@@ -95,7 +212,11 @@ def check_scalar_indentation(conf, token, context):
         if token.start_mark.buffer[line_start + indent] == '\n':
             continue
 
-        if indent != expected_indent:
+        if indent < expected_indent:
+            yield LintProblem(line_no, indent + 1,
+                              ('wrong indentation: expected at least %d but '
+                               'found %d') % (expected_indent, indent))
+        elif conf['check-multi-line-strings'] and indent > expected_indent:
             yield LintProblem(line_no, indent + 1,
                               'wrong indentation: expected %d but found %d' %
                               (expected_indent, indent))

yamllint/rules/line_length.py

@@ -14,6 +14,33 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+"""
+Use this rule to set a limit to lines length.
+
+.. rubric:: Options
+
+* ``max`` defines the maximal (inclusive) length of lines.
+
+.. rubric:: Examples
+
+#. With ``line-length: {max: 70}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    long sentence:
+      Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do
+      eiusmod tempor incididunt ut labore et dolore magna aliqua.
+
+   the following code snippet would **FAIL**:
+   ::
+
+    long sentence:
+      Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
+      tempor incididunt ut labore et dolore magna aliqua.
+"""
+
+
 from yamllint.errors import LintProblem
 
 

yamllint/rules/new_line_at_end_of_file.py

@@ -14,6 +14,16 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+"""
+Use this rule to require a new line character (``\\n``) at the end of files.
+
+The POSIX standard `requires the last line to end with a new line character
+<http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_206>`_.
+All UNIX tools expect a new line at the end of files. Most text editors use
+this convention too.
+"""
+
+
 from yamllint.errors import LintProblem
 
 

yamllint/rules/new_lines.py

@@ -14,12 +14,22 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+"""
+Use this rule to force the type of new line characters.
+
+.. rubric:: Options
+
+* Set ``type`` to ``unix`` to use UNIX-typed new line characters (``\\n``), or
+  ``dos`` to use DOS-typed new line characters (``\\r\\n``).
+"""
+
+
 from yamllint.errors import LintProblem
 
 
 ID = 'new-lines'
 TYPE = 'line'
-CONF = {'type': str}
+CONF = {'type': ('unix', 'dos')}
 
 
 def check(conf, line):

yamllint/rules/trailing_spaces.py

@@ -14,6 +14,29 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+"""
+Use this rule to forbid trailing spaces at the end of lines.
+
+.. rubric:: Examples
+
+#. With ``trailing-spaces: {}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    this document doesn't contain
+    any trailing
+    spaces
+
+   the following code snippet would **FAIL**:
+   ::
+
+    this document contains     """ """
+    trailing spaces
+    on lines 1 and 3         """ """
+"""
+
+
 import string
 
 from yamllint.errors import LintProblem