diff --git a/README.rst b/README.rst index cfff7a1..b54604a 100644 --- a/README.rst +++ b/README.rst @@ -3,8 +3,9 @@ yamllint A linter for YAML files. -yamllint does not only check for syntax validity, but for common cosmetic -conventions such as lines length, trailing spaces, indentation, etc. +yamllint does not only check for syntax validity, but for weirdnesses like key +repetition and cosmetic problems such as lines length, trailing spaces, +indentation, etc. .. image:: https://travis-ci.org/adrienverge/yamllint.svg?branch=master diff --git a/docs/index.rst b/docs/index.rst index e2d975a..773b143 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,10 +1,7 @@ yamllint documentation ====================== -A linter for YAML files. - -yamllint does not only check for syntax validity, but for common cosmetic -conventions such as lines length, trailing spaces, indentation, etc. +.. automodule:: yamllint Screenshot ---------- diff --git a/yamllint/__init__.py b/yamllint/__init__.py index 07aecb8..ce88125 100644 --- a/yamllint/__init__.py +++ b/yamllint/__init__.py @@ -14,12 +14,16 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . +"""A linter for YAML files. + +yamllint does not only check for syntax validity, but for weirdnesses like key +repetition and cosmetic problems such as lines length, trailing spaces, +indentation, etc.""" + + APP_NAME = 'yamllint' APP_VERSION = '0.7.0' -APP_DESCRIPTION = """A linter for YAML files. - -yamllint does not only check for syntax validity, but for common cosmetic -conventions such as lines length, trailing spaces, indentation, etc.""" +APP_DESCRIPTION = __doc__ __author__ = u'Adrien Vergé' __copyright__ = u'Copyright 2016, Adrien Vergé'