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

Jump to bottom

Rename _GMT_DATASET.to_dataframe to .to_pandas and _GMT_GRID.to_dataarray/_GMT_IMAGE.to_dataarray to .to_xarray #3651

Open
seisman opened this issue Nov 26, 2024 · 0 comments
Open

Rename _GMT_DATASET.to_dataframe to .to_pandas and _GMT_GRID.to_dataarray/_GMT_IMAGE.to_dataarray to .to_xarray #3651

seisman opened this issue Nov 26, 2024 · 0 comments
Labels
discussions Need more discussion before taking further actions

Comments

@seisman
Copy link
Member

seisman commented Nov 26, 2024

Here I propose renaming the following methods to align with conventions adopted by xarray/pandas/pyarrow:

  • Rename _GMT_DATASET.to_dataframe to .to_pandas.
  • Rename _GMT_GRID.to_dataarray and _GMT_IMAGE.to_dataarray to .to_xarray

Reference:

Since _GMT_DATASET/_GMT_GRID/_GMT_IMAGE are internal data structures, we can rename these functions without deprecation warnings. Of course, we can also go with the deprecation cycle if you think it's necessary.
@seisman seisman added the discussions Need more discussion before taking further actions label Nov 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
discussions Need more discussion before taking further actions
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@seisman