Doc: Enhance short description

adrienverge · Jan 24, 2016 · 376a6ed · 376a6ed
1 parent a1eb9d7
commit 376a6ed
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 2 deletions.
diff --git a/README.rst b/README.rst
@@ -3,6 +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.
+
 .. image::
    https://travis-ci.org/adrienverge/yamllint.svg?branch=master
    :target: https://travis-ci.org/adrienverge/yamllint

diff --git a/docs/index.rst b/docs/index.rst
@@ -3,6 +3,9 @@ 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.
+
 Screenshot
 ----------
 

diff --git a/setup.py b/setup.py
@@ -24,7 +24,8 @@
     name=APP_NAME,
     version=APP_VERSION,
     author=__author__,
-    description=APP_DESCRIPTION,
+    description=APP_DESCRIPTION.split('\n')[0],
+    long_description=APP_DESCRIPTION,
     license=__license__,
     keywords=['yaml', 'lint', 'linter', 'syntax', 'checker'],
     url='https://github.com/adrienverge/yamllint',

diff --git a/yamllint/__init__.py b/yamllint/__init__.py
@@ -16,7 +16,10 @@
 
 APP_NAME = 'yamllint'
 APP_VERSION = '0.5.2'
-APP_DESCRIPTION = 'A linter for YAML files.'
+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."""
 
 __author__ = u'Adrien Vergé'
 __copyright__ = u'Copyright 2016, Adrien Vergé'