Figure.coast/pygmt.select/pygmt.grdlandmask: Use long names ("crude"/"low"/"intermediate"/"high"/"full") for the 'resolution' parameter

[seisman]

This PR updates the resolution parameter for Figure.coast/pygmt.select/pygmt.grdlandmask to use long names.

[codspeed-hq]

CodSpeed Performance Report

Merging #3013 will not alter performance

_{Comparing coast/resolution (50f6406) with main (438edce)}

Summary

✅ 104 untouched benchmarks

[seisman]

Ping @GenericMappingTools/pygmt-maintainers for thoughts on the proposed changes towards more Pythonic arguments.

[seisman]

Actually, this PR is not needed if PR #3238 is implemented.

[seisman]

Actually, this PR is not needed if PR #3238 is implemented.

It's likely PR #3238 will take months to implement, so I feel it's better to have this PR merged before that PR>

[weiji14]

Thoughts on making a StrEnum out of this?

[seisman]

What are the benefits? This private function will likely be removed after #3239 is implemented.

[seisman]

GMT uses short-form arguments, but we prefer long-form arguments in PyGMT. Another example is in #3012. It will be a lot of work if we define StrEnum for all these cases. #3239 proposed a more general solution for it.

[weiji14]

Yeah, StrEnum will be a lot more work, and we'll need to bring in something like pydantic (mentioned at #3239 (comment)) to fully enable runtime checks. Ok to keep this as is for now, and wait for #3239.

[seisman]

The simplest form of this line is:

kwargs["D"] = _parse_coastline_resolution(resolution)

but to support short-form parameters like D="f", we have to write the code like:

kwargs["D"] = kwargs.get("D", _parse_coastline_resolution(resolution))

The D="resolution" line is also removed from the use_alias decorator. Otherwise, we have to write codes like below:

kwargs["D"] = _parse_coastline_resolution(kwgars.get("D"))

It's fine, but then ruff will complain that the resolution parameter is unused.

[seisman]

After removing D="resolution", this alias won't be shown in the alias list. Need to wait for #3945.