-
Notifications
You must be signed in to change notification settings - Fork 218
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
Remote Datasets: Adjust attributes - remove "title", use default of "name" and "long_name", introduce "description" #3048
Conversation
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good!
Need to update the PR title to reflect the changes. |
I update the description of this PR in the initial comment at the beginning and tried to find a better title (not 100 % happy with it - feel free to adjust). |
The failing But there is also a failing windows test |
The Windows failure is unrelated to this PR. |
@yvonnefroehlich Nice work. Thanks! |
Description of proposed changes
Currently the naming of the remote datasets is inconistent (please see #2914 (comment)). This PR applies the following changes to improve consistency:
load_*
API functions unchangedearth_age
title
name
explicitly anymore, as it defaults now to"z"
(see Refactor the _load_remote_dataset function to load tiled and non-tiled grids in a consistent way #3120)
long_name
explicitly anymore, as it defaults now to"quantity (unit)"
(see Refactor the _load_remote_dataset function to load tiled and non-tiled grids in a consistent way #3120)
description
. It should match the title on the dataset documentation page (https://www.generic-mapping-tools.org/remote-datasets/), but use lower-case letter when possible e.g.,EarthByte Earth seafloor crustal age
, rather thanEarthByte Earth Seafloor Crustal Age
.earth_relief
intoearth_gebco
andearth_igpp
inload_remote_dataset.py
load_remote_dataset.py
Fixes #2914
Reminders
make format
andmake check
to make sure the code follows the style guide.doc/api/index.rst
.Slash Commands
You can write slash commands (
/command
) in the first line of a comment to performspecific operations. Supported slash command is:
/format
: automatically format and lint the code