Skip to content

Figure.image / Figure.grdimage: Deprecate parameter bitcolor to bit_color (Will be removed in v0.20.0) #4280

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.

Sign up for GitHub

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

Draft
yvonnefroehlich wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Figure.image / Figure.grdimage: Deprecate parameter bitcolor to bit_color (Will be removed in v0.20.0) #4280

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions pygmt/src/grdimage.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,18 @@
from pygmt._typing import PathLike
from pygmt.alias import Alias, AliasSystem
from pygmt.clib import Session
from pygmt.helpers import build_arg_list, fmt_docstring, use_alias
from pygmt.helpers import build_arg_list, deprecate_parameter, fmt_docstring, use_alias

__doctest_skip__ = ["grdimage"]


@fmt_docstring
@deprecate_parameter("bitcolor", "bit_color", "v0.18.0", remove_version="v0.20.0")
@use_alias(
C="cmap",
D="img_in",
E="dpi",
G="bitcolor",
G="bit_color",
I="shading",
Q="nan_transparent",
n="interpolation",
Expand Down Expand Up @@ -109,7 +110,7 @@ def grdimage( # noqa: PLR0913
same size (rows and columns) as the input file. Specify **i** to
use the PostScript image operator to interpolate the image at the
device resolution.
bitcolor : str
bit_color : str
*color*\ [**+b**\|\ **f**\].
This parameter only applies when a resulting 1-bit image otherwise
would consist of only two colors: black (0) and white (255). If so,
Expand Down
7 changes: 4 additions & 3 deletions pygmt/src/image.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,13 @@
from pygmt._typing import PathLike
from pygmt.alias import Alias, AliasSystem
from pygmt.clib import Session
from pygmt.helpers import build_arg_list, fmt_docstring, use_alias
from pygmt.helpers import build_arg_list, deprecate_parameter, fmt_docstring, use_alias
from pygmt.params import Box


@fmt_docstring
@use_alias(D="position", G="bitcolor")
@deprecate_parameter("bitcolor", "bit_color", "v0.18.0", remove_version="v0.20.0")
@use_alias(D="position", G="bit_color")
def image(
self,
imagefile: PathLike,
Expand Down Expand Up @@ -74,7 +75,7 @@ def image(
box is drawn using :gmt-term:`MAP_FRAME_PEN`. To customize the box appearance,
pass a :class:`pygmt.params.Box` object to control style, fill, pen, and other
box properties.
bitcolor : str or list
bit_color : str or list
[*color*][**+b**\|\ **f**\|\ **t**].
Change certain pixel values to another color or make them transparent.
For 1-bit images you can specify an alternate *color* for the
Expand Down