Skip to content
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.

Sign up for GitHub

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

Improve config-user documentation #740

Merged
merged 1 commit into from
Aug 5, 2020
Merged

Improve config-user documentation #740

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions doc/quickstart/run.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ To run a recipe, call ``esmvaltool run`` with the desired recipe:

esmvaltool run recipe_python.yml

If the config user is not in the default ``{HOME}\.esmvaltool\`` path you can
pass its path explicitly:
If the configuration file is not in the default location
``~/.esmvaltool/config-user.yml``, you can pass its path explicitly:

.. code:: bash

Expand Down
4 changes: 2 additions & 2 deletions esmvalcore/_main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ def get_config_user(cls, overwrite=False, path=None):
Parameters
----------
overwrite: boolean
Name of the recipe to get
Overwrite an existing file.
path: str
If not provided, the file will be copied to
.esmvaltool in the user's home.
Expand All @@ -166,7 +166,7 @@ def get_config_developer(cls, overwrite=False, path=None):
Parameters
----------
overwrite: boolean
Name of the recipe to get
Overwrite an existing file.
path: str
If not provided, the file will be copied to
.esmvaltool in the user's home.
Expand Down