Skip to content

Docs: advertize .yaml suffix instead of .yml (close #498) #605

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions invoke/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -697,7 +697,7 @@ def load_system(self, merge=True):
Load a system-level config file, if possible.

Checks the configured ``_system_prefix`` path, which defaults to
``/etc``, and will thus load files like ``/etc/invoke.yml``.
``/etc``, and will thus load files like ``/etc/invoke.yaml``.

:param bool merge:
Whether to merge the loaded data into the central config. Default:
Expand All @@ -714,7 +714,7 @@ def load_user(self, merge=True):
Load a user-level config file, if possible.

Checks the configured ``_user_prefix`` path, which defaults to ``~/.``,
and will thus load files like ``~/.invoke.yml``.
and will thus load files like ``~/.invoke.yaml``.

:param bool merge:
Whether to merge the loaded data into the central config. Default:
Expand All @@ -736,7 +736,7 @@ def load_project(self, merge=True):

Thus, if one were to run the CLI tool against a tasks collection
``/home/myuser/code/tasks.py``, `load_project` would seek out files
like ``/home/myuser/code/invoke.yml``.
like ``/home/myuser/code/invoke.yaml``.

:param bool merge:
Whether to merge the loaded data into the central config. Default:
Expand Down
2 changes: 1 addition & 1 deletion sites/docs/concepts/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ For each configuration file location mentioned in the previous section, we
search for files ending in ``.yaml``, ``.yml``, ``.json`` or ``.py`` (**in that
order!**), load the first one we find, and ignore any others that might exist.

For example, if Invoke is run on a system containing both ``/etc/invoke.yml``
For example, if Invoke is run on a system containing both ``/etc/invoke.yaml``
*and* ``/etc/invoke.json``, **only the YAML file will be loaded**. This helps
keep things simple, both conceptually and in the implementation.

Expand Down
2 changes: 1 addition & 1 deletion sites/docs/concepts/namespaces.rst
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ or collection names are interpreted to be dashes instead, by default::
If you'd prefer the underscores to remain instead, you can update your
configuration to set ``tasks.auto_dash_names`` to ``False`` in one of the
non-runtime :ref:`config files <config-files>` (system, user, or project.) For
example, in ``~/.invoke.yml``::
example, in ``~/.invoke.yaml``::

tasks:
auto_dash_names: false
Expand Down