From 376a6ed484e39c68a75f34ced7e6eb30ac88ebef Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adrien=20Verg=C3=A9?= Date: Sun, 24 Jan 2016 18:37:24 +0100 Subject: [PATCH] Doc: Enhance short description --- README.rst | 3 +++ docs/index.rst | 3 +++ setup.py | 3 ++- yamllint/__init__.py | 5 ++++- 4 files changed, 12 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 36adbfa..cfff7a1 100644 --- 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 index e127160..e2d975a 100644 --- 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 index d7d8abd..e2d7633 100644 --- a/setup.py +++ b/setup.py @@ -24,7 +24,8 @@ setup( 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 index 539b45f..805f04f 100644 --- 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é'