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.

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

Merged
merged 68 commits into from
Apr 24, 2024

Conversation

yvonnefroehlich
Copy link
Member

@yvonnefroehlich yvonnefroehlich commented Feb 7, 2024

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:

Fixes #2914

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
  • If adding new functionality, add an example to docstrings or tutorials.
  • Use underscores (not hyphens) in names of Python files and directories.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash command is:

  • /format: automatically format and lint the code

@yvonnefroehlich yvonnefroehlich added the maintenance Boring but important stuff for the core devs label Feb 7, 2024
@seisman seisman added this to the 0.12.0 milestone Feb 17, 2024
@yvonnefroehlich yvonnefroehlich self-assigned this Mar 1, 2024
pygmt/datasets/earth_magnetic_anomaly.py Outdated Show resolved Hide resolved
pygmt/datasets/load_remote_dataset.py Outdated Show resolved Hide resolved
Copy link
Member

@seisman seisman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@seisman seisman added the final review call This PR requires final review and approval from a second reviewer label Apr 23, 2024
@seisman
Copy link
Member

seisman commented Apr 23, 2024

Need to update the PR title to reflect the changes.

@yvonnefroehlich yvonnefroehlich changed the title Remote Datasets: Make dataset name, long_name, and documentation consistent; remove dataset title Remote Datasets: Make "key" consistent, Remove "title", Add "description" Apr 23, 2024
@yvonnefroehlich yvonnefroehlich changed the title Remote Datasets: Make "key" consistent, Remove "title", Add "description" Remote Datasets: Adjust attributes - Make "key" consistent, Remove "title", Introduce "description" Apr 23, 2024
@yvonnefroehlich yvonnefroehlich changed the title Remote Datasets: Adjust attributes - Make "key" consistent, Remove "title", Introduce "description" Remote Datasets: Adjust attributes - Remove "title", Use default of "name" and "long_name", Introduce "description" Apr 23, 2024
@yvonnefroehlich yvonnefroehlich changed the title Remote Datasets: Adjust attributes - Remove "title", Use default of "name" and "long_name", Introduce "description" Remote Datasets: Adjust attributes - remove "title", use default of "name" and "long_name", introduce "description" Apr 23, 2024
@yvonnefroehlich
Copy link
Member Author

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).

@yvonnefroehlich
Copy link
Member Author

The failing macos-latest - Python 3.10 / NumPy 1.23 (pull_request) and macos-latest - Python 3.12 / NumPy 1.26 (pull_request) tests are probably related to issue #3194.

But there is also a failing windows test windows-latest - Python 3.10 / NumPy 1.23 (pull_request). However, windows-latest - Python 3.12 / NumPy 1.26 (pull_request) is successful.

@seisman
Copy link
Member

seisman commented Apr 23, 2024

The failing macos-latest - Python 3.10 / NumPy 1.23 (pull_request) and macos-latest - Python 3.12 / NumPy 1.26 (pull_request) tests are probably related to issue #3194.

But there is also a failing windows test windows-latest - Python 3.10 / NumPy 1.23 (pull_request). However, windows-latest - Python 3.12 / NumPy 1.26 (pull_request) is successful.

The Windows failure is unrelated to this PR.

@seisman seisman merged commit 5234b52 into main Apr 24, 2024
4 checks passed
@seisman seisman deleted the adjust-names-datasets branch April 24, 2024 11:19
@seisman
Copy link
Member

seisman commented Apr 24, 2024

@yvonnefroehlich Nice work. Thanks!

@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Apr 24, 2024
seisman added a commit to seisman/pygmt that referenced this pull request Apr 25, 2024
…name" and "long_name", introduce "description" (GenericMappingTools#3048)

Co-authored-by: Dongdong Tian <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Boring but important stuff for the core devs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remote Datasets: Inconsistent dataset title, name and long_name
3 participants