pygmt.select: Deprecate parameter gridmask to mask_grid (Will be removed in v0.20.0)

[yvonnefroehlich]

Description of proposed changes

Use underscores between words in parameter names; related to #2014.

Preview: https://pygmt-dev--4283.org.readthedocs.build/en/4283/api/generated/pygmt.select.html

Guidelines

• General Guidelines for Pull Request
• Guidelines for Contributing Documentation
• Guidelines for Contributing Code

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

[seisman]

I'm thinking if mask_grid makes more sense than grid_mask

[yvonnefroehlich]

I'm thinking if mask_grid makes more sense than grid_mask

Hm. I also though a bit about changing the order here and I am unsure what is better. I think having "grid" as first word should indicate that the input to this parameter is a grid. However, for me, mask_grid sounds better.

gridmask (str) – Pass all locations that are inside the valid data area of the grid gridmask. Nodes that are outside are either NaN or zero.

---

Another aspect is the alias of -N:

• for pygmt.grdlandmask it is maks_values
• for pygmt.select it is mask (the GMT docs uses mask_values)

[seisman]

Another aspect is the alias of -N:

• for pygmt.grdlandmask it is maks_values
• for pygmt.select it is mask (the GMT docs uses mask_values)

Yes, this should also be consistent.