Skip to content

Figure.histogram: Migrate the parameter horizontal to the new alias system #4880

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 1 commit into
base: main
Choose a base branch
from
+4 −2
Open

Figure.histogram: Migrate the parameter horizontal to the new alias system #4880

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
6 changes: 4 additions & 2 deletions pygmt/src/histogram.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@

@fmt_docstring
@use_alias(
A="horizontal",
D="annotate",
F="center",
L="extreme",
Expand All @@ -45,6 +44,7 @@ def histogram(
cmap: str | bool = False,
pen: str | None = None,
fill: str | None = None,
horizontal: bool = False,
projection: str | None = None,
region: Sequence[float | str] | str | None = None,
frame: Frame | Axis | Literal["none"] | str | Sequence[str] | bool = False,
Expand All @@ -62,6 +62,7 @@ def histogram(
Full GMT docs at :gmt-docs:`histogram.html`.

$aliases
- A = horizontal
- B = frame
- C = cmap
- E = bar_width, **+o**: bar_offset
Expand Down Expand Up @@ -127,7 +128,7 @@ def histogram(
stairs : bool
Draw a stairs-step diagram which does not include the internal bars
of the default histogram.
horizontal : bool
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
x-axis is plotted vertically and the y-axis is plotted horizontally.
Expand Down Expand Up @@ -168,6 +169,7 @@ def histogram(
)

aliasdict = AliasSystem(
A=Alias(horizontal, name="horizontal"),
C=Alias(cmap, name="cmap"),
E=[
Alias(bar_width, name="bar_width"),
Expand Down
Loading