Doc: Update description

pull/4/head
Adrien Vergé 9 years ago
parent ba9d86d645
commit 0e04ee29e6

@ -3,8 +3,9 @@ yamllint
A linter for YAML files. A linter for YAML files.
yamllint does not only check for syntax validity, but for common cosmetic yamllint does not only check for syntax validity, but for weirdnesses like key
conventions such as lines length, trailing spaces, indentation, etc. repetition and cosmetic problems such as lines length, trailing spaces,
indentation, etc.
.. image:: .. image::
https://travis-ci.org/adrienverge/yamllint.svg?branch=master https://travis-ci.org/adrienverge/yamllint.svg?branch=master

@ -1,10 +1,7 @@
yamllint documentation yamllint documentation
====================== ======================
A linter for YAML files. .. automodule:: yamllint
yamllint does not only check for syntax validity, but for common cosmetic
conventions such as lines length, trailing spaces, indentation, etc.
Screenshot Screenshot
---------- ----------

@ -14,12 +14,16 @@
# You should have received a copy of the GNU General Public License # You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>. # along with this program. If not, see <http://www.gnu.org/licenses/>.
"""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_NAME = 'yamllint'
APP_VERSION = '0.7.0' APP_VERSION = '0.7.0'
APP_DESCRIPTION = """A linter for YAML files. APP_DESCRIPTION = __doc__
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é' __author__ = u'Adrien Vergé'
__copyright__ = u'Copyright 2016, Adrien Vergé' __copyright__ = u'Copyright 2016, Adrien Vergé'

Loading…
Cancel
Save