pygmt.project: Deprecate parameter unit to units (Will be removed in v0.20.0) #4297
Conversation
pygmt/src/grdproject.py
Outdated
| @fmt_docstring | ||
| @use_alias(E="dpi", F="scaling", I="inverse", M="unit", n="interpolation") | ||
| @deprecate_parameter("unit", "units", "v0.18.0", remove_version="v0.20.0") | ||
| @use_alias(E="dpi", F="scaling", I="inverse", M="units", n="interpolation") |
There was a problem hiding this comment.
I think it should be unit, not units, since it takes one single unit in this module.
There was a problem hiding this comment.
I was wondering it it makes sense to have this consistent across function / methods and always use plural.
There was a problem hiding this comment.
I think we should use unit and units in different cases.
There was a problem hiding this comment.
So, we only want to change pygmt.project?
yvonnefroehlich
changed the title
Actually, I feel aliasing |
I have to look at this in more detail, as I do not use |
Description of proposed changes
Use the plural
unitsif the units of multiple quanities can be adjusted; related to #2014.Preview:
Guidelines
Slash Commands
You can write slash commands (
/command) in the first line of a comment to performspecific operations. Supported slash command is:
/format: automatically format and lint the code