pygmt.project: Deprecate parameter unit to units (Will be removed in v0.2X.0)

[yvonnefroehlich]

Description of proposed changes

Use the plural units if the units of multiple quanities can be adjusted; related to #2014.

Preview:

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 think it should be unit, not units, since it takes one single unit in this module.

[yvonnefroehlich]

I was wondering it it makes sense to have this consistent across function / methods and always use plural.

[seisman]

I think we should use unit and units in different cases.

[yvonnefroehlich]

So, we only want to change pygmt.project?

[seisman]

Specify that x, y, r, s are in degrees while p, q, dist, lmin, lmax, wmin, wmax are in km. If -Q is not set, then all these are assumed to be in the same units.

Actually, I feel aliasing -Q to unit is a mistake. GMT.jl and GMT use km instead, but I feel km is also not a good name.

[yvonnefroehlich]

Specify that x, y, r, s are in degrees while p, q, dist, lmin, lmax, wmin, wmax are in km. If -Q is not set, then all these are assumed to be in the same units.

Actually, I feel aliasing -Q to unit is a mistake. GMT.jl and GMT use km instead, but I feel km is also not a good name.

I have to look at this in more detail, as I do not use pygmt.project often. But agree km is not optimal as a name. Converted the PR to draft.