Skip to content

Add enums GridRegistration and GridType for grid registration and type - #3693

Merged
seisman merged 7 commits into
mainfrom
doc/enums
Dec 19, 2024
Merged

Add enums GridRegistration and GridType for grid registration and type#3693
seisman merged 7 commits into
mainfrom
doc/enums

Conversation

@seisman

@seismanseisman commented Dec 17, 2024

Copy link
Copy Markdown
Member

@seismanseisman added the documentation Improvements or additions to documentation label Dec 17, 2024
@seismanseisman added this to the 0.14.0 milestone Dec 17, 2024
@seismanseisman added the needs review This PR has higher priority and needs review. label Dec 18, 2024
@michaelgrundmichaelgrund added final review call This PR requires final review and approval from a second reviewer and removed needs review This PR has higher priority and needs review. labels Dec 18, 2024
@weiji14

Copy link
Copy Markdown
Member

Ok with the enum API style, but before approving, I want to check that we actually want to expose the GridFormat enum to users? In #3449 (comment), I thought we decided not to include GridFormat, but document GridRegistration and GridType (suggested in #499 (comment))?

@seisman

Copy link
Copy Markdown
MemberAuthor

Ok with the enum API style, but before approving, I want to check that we actually want to expose the GridFormat enum to users? In #3449 (comment), I thought we decided not to include GridFormat, but document GridRegistration and GridType (suggested in #499 (comment))?

We don't have to document GridFormat here. I've cherry-picked the changes in #3696 (New enums GridReg and GridType) into this PR so that this PR can be reused.

@seismanseisman added enhancement Improving an existing feature and removed final review call This PR requires final review and approval from a second reviewer documentation Improvements or additions to documentation labels Dec 19, 2024
@seismanseisman changed the title Add enums to the API documentationAdd enums GridReg and GridType for grid registration and coordinate systemDec 19, 2024
Comment threadpygmt/enums.py Outdated
EF = 24 #: ESRI Arc/Info ASCII Grid Interchange format (ASCII float)


class GridReg(IntEnum):

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

GridReg or GridRegistration?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I'd prefer GridRegistration

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

OK, renamed to GridRegistration in this PR.

@seismanseisman changed the title Add enums GridReg and GridType for grid registration and coordinate systemAdd enums GridRegistration and GridType for grid registration and coordinate systemDec 19, 2024
@seismanseisman changed the title Add enums GridRegistration and GridType for grid registration and coordinate systemAdd enums GridRegistration and GridType for grid registration and typeDec 19, 2024
@seismanseisman mentioned this pull request Dec 19, 2024
49 tasks
@seisman
seisman merged commit 8fab7c3 into mainDec 19, 2024
@seisman
seisman deleted the doc/enums branch December 19, 2024 03:56
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancementImproving an existing feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@seisman@weiji14@michaelgrund