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

Document gmtwhich -Ga option to download to appropriate cache folder #1554

Merged
merged 2 commits into from
Oct 3, 2021
Merged

Document gmtwhich -Ga option to download to appropriate cache folder #1554

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e51347d
Document gmtwhich -Ga option to download to appropriate cache folder
weiji14 Oct 1, 2021
ab505bb
Merge branch 'main' into gmtwhich-download-a
michaelgrund Oct 2, 2021
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
16 changes: 11 additions & 5 deletions pygmt/src/which.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
@use_alias(G="download", V="verbose")
@kwargs_to_strings(fname="sequence_space")
def which(fname, **kwargs):
"""
r"""
Find the full path to specified files.

Reports the full paths to the files given through *fname*. We look for
Expand All @@ -37,10 +37,16 @@ def which(fname, **kwargs):
fname : str or list
One or more file names of any data type (grids, tables, etc.).
download : bool or str
If the file is downloadable and not found, we will try to download the
it. Use True or 'l' (default) to download to the current directory. Use
'c' to place in the user cache directory or 'u' user data directory
instead.
[**a**\|\ **c**\|\ **l**\|\ **u**].
If the fname argument is a downloadable file (either a complete URL, an
@file for downloading from the GMT data server, or @earth_relief_xxy)
we will try to download the file if it is not found in your local data
or cache dirs. By default [``download=True`` or ``download="l"``] we
download to the current directory. Use **a** to place files in the
appropriate folder under the user directory (this is where GMT normally
places downloaded files), **c** to place it in the user cache
directory, or **u** for the user data directory instead (i.e., ignoring
any subdirectory structure).
{V}

Returns
Expand Down