Skip to content

Figure.grdimage: Deprecate parameter "bit_color" to "bitcolor" (remove in v0.12.0) #2635

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

Merged
seisman merged 4 commits into from
Aug 21, 2023
Merged

Figure.grdimage: Deprecate parameter "bit_color" to "bitcolor" (remove in v0.12.0) #2635

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
258f44e
Change 'bit_color' to 'bitcolor'
yvonnefroehlich Aug 19, 2023
ad91293
Add 'deprecate_parameter' decorator
yvonnefroehlich Aug 19, 2023
d43e1ef
Fix alphabetical order
yvonnefroehlich Aug 19, 2023
7217380
Merge branch 'main' into change-grdimage-bit_color2bitcolor
yvonnefroehlich Aug 20, 2023
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
13 changes: 10 additions & 3 deletions pygmt/src/grdimage.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,26 @@
grdimage - Plot grids or images.
"""
from pygmt.clib import Session
from pygmt.helpers import build_arg_string, fmt_docstring, kwargs_to_strings, use_alias
from pygmt.helpers import (
build_arg_string,
deprecate_parameter,
fmt_docstring,
kwargs_to_strings,
use_alias,
)

__doctest_skip__ = ["grdimage"]


@fmt_docstring
@deprecate_parameter("bit_color", "bitcolor", "v0.10.0", remove_version="v0.12.0")
@use_alias(
A="img_out",
B="frame",
C="cmap",
D="img_in",
E="dpi",
G="bit_color",
G="bitcolor",
I="shading",
J="projection",
M="monochrome",
Expand Down Expand Up @@ -107,7 +114,7 @@ def grdimage(self, grid, **kwargs):
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.
bit_color : str
bitcolor : 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