-
Notifications
You must be signed in to change notification settings - Fork 224
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
Add enums GridRegistration and GridType for grid registration and type #3693
Conversation
Ok with the enum API style, but before approving, I want to check that we actually want to expose the |
We don't have to document |
pygmt/enums.py
Outdated
@@ -37,3 +37,21 @@ class GridFormat(IntEnum): | |||
GD = 22 #: Import through GDAL | |||
EI = 23 #: ESRI Arc/Info ASCII Grid Interchange format (ASCII integer) | |||
EF = 24 #: ESRI Arc/Info ASCII Grid Interchange format (ASCII float) | |||
|
|||
|
|||
class GridReg(IntEnum): |
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.
GridReg
or GridRegistration
?
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.
I'd prefer GridRegistration
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.
OK, renamed to GridRegistration
in this PR.
This PR adds the enums
GridRegistration
andGridType
for grid registration and type.In #3449, we added the enums
GridFormat
, but we didn't add it to the API documentation, because we didn't find a good way to display the enums (see comments in PR #3449). This PR makes the docs work by adding a newautosummary
template for enums.Preview:
References: