Skip to content

Figure.histogram: Migrate parameter 'stairs' to the new alias system #4884

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

Open
seisman wants to merge 2 commits into
base: main
Choose a base branch
from
+6 −4
Open

Figure.histogram: Migrate parameter 'stairs' to the new alias system #4884

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fe4d710
Figure.histogram: Migrate parameter 'stairs' to the new alias system
seisman Sep 8, 2026
df1fab1
Merge branch 'main' into histogram/stairs
seisman Sep 13, 2026
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
10 changes: 6 additions & 4 deletions pygmt/src/histogram.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@
F="center",
L="extreme",
N="distribution",
S="stairs",
T="series",
Z="histtype",
b="binary",
Expand All @@ -44,6 +43,7 @@ def histogram(
pen: str | None = None,
fill: str | None = None,
horizontal: bool = False,
stairs: bool = False,
cumulative: bool | Literal["reverse"] = False,
projection: str | None = None,
region: Sequence[float | str] | str | None = None,
Expand All @@ -70,6 +70,7 @@ def histogram(
- J = projection
- Q = cumulative
- R = region
- S = stairs
- V = verbose
- W = pen
- c = panel
Expand Down Expand Up @@ -125,9 +126,9 @@ def histogram(
bins. To only include extreme values below first bin into the first
bin, use **l**, and to only include extreme values above the last bin
into that last bin, use **h**.
stairs : bool
Draw a stairs-step diagram which does not include the internal bars
of the default histogram.
stairs
Draw a stairs-step diagram which does not include the internal bars of the
default histogram.
horizontal
Plot the histogram horizontally from x = 0 [Default is vertically from y = 0].
The plot dimensions remain the same, but the two axes are flipped, i.e., the
Expand Down Expand Up @@ -177,6 +178,7 @@ def histogram(
],
G=Alias(fill, name="fill"),
Q=Alias(cumulative, name="cumulative", mapping={"reverse": "r"}),
S=Alias(stairs, name="stairs"),
W=Alias(pen, name="pen"),
).add_common(
B=frame,
Expand Down
Loading