Skip to content

Commit

Permalink
Use '.yaml' extension as default, not '.yml'
Browse files Browse the repository at this point in the history
As someone said [1] on the internet:

    Say ".yaml" not ".yml".
    This is not MS-DOS, and YML is a Yahoo XML dialect.

Similarly, we use '.json', not '.jsn'.

[1]: ceph/s3-tests@e17c56a
  • Loading branch information
adrienverge committed Mar 7, 2016
1 parent 688858e commit 41733fc
Show file tree
Hide file tree
Showing 7 changed files with 8 additions and 8 deletions.
4 changes: 2 additions & 2 deletions README.rst
Expand Up @@ -75,15 +75,15 @@ Usage
.. code:: bash
# Use a pre-defined lint configuration
yamllint -d relaxed file.yml
yamllint -d relaxed file.yaml
# 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
yamllint -f parsable file.yaml
Configuration example
^^^^^^^^^^^^^^^^^^^^^
Expand Down
6 changes: 3 additions & 3 deletions docs/configuration.rst
Expand Up @@ -10,14 +10,14 @@ directory, or use the ``-c`` option:

.. code:: bash
yamllint -c ~/myconfig file.yml
yamllint -c ~/myconfig file.yaml
Default configuration
---------------------

Unless told otherwise, yamllint uses its ``default`` configuration:

.. literalinclude:: ../yamllint/conf/default.yml
.. literalinclude:: ../yamllint/conf/default.yaml
:language: yaml

Details on rules can be found on :doc:`the rules page <rules>`.
Expand Down Expand Up @@ -85,7 +85,7 @@ For instance:

.. code:: bash
yamllint -d "{extends: relaxed, rules: {line-length: {max: 120}}}" file.yml
yamllint -d "{extends: relaxed, rules: {line-length: {max: 120}}}" file.yaml
Errors and warnings
-------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart.rst
Expand Up @@ -81,7 +81,7 @@ option:

.. code:: bash
yamllint -c ~/myconfig file.yml
yamllint -c ~/myconfig file.yaml
.. note::

Expand Down
2 changes: 1 addition & 1 deletion setup.py
Expand Up @@ -44,7 +44,7 @@

packages=find_packages(),
entry_points={'console_scripts': ['yamllint=yamllint.cli:run']},
package_data={'yamllint': ['conf/*.yml'],
package_data={'yamllint': ['conf/*.yaml'],
'tests': ['yaml-1.2-spec-examples/*']},
install_requires=['pyyaml'],
tests_require=['nose'],
Expand Down
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion yamllint/config.py
Expand Up @@ -129,7 +129,7 @@ def get_extended_config_file(name):
# Is it a standard conf shipped with yamllint...
if '/' not in name:
std_conf = os.path.join(os.path.dirname(os.path.realpath(__file__)),
'conf', name + '.yml')
'conf', name + '.yaml')

if os.path.isfile(std_conf):
return std_conf
Expand Down

0 comments on commit 41733fc

Please sign in to comment.