Skip to content

Commit d3fe05e

Browse files
committed
add docstring for extreme; wrap U/V/t
1 parent 2d2df08 commit d3fe05e

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

pygmt/src/histogram.py

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,22 @@
1515
F="center",
1616
G="fill",
1717
J="projection",
18+
L="extreme",
1819
N="normal",
1920
Q="cumulative",
2021
R="region",
2122
S="step",
2223
T="series",
24+
U="timestamp",
2325
W="pen",
2426
X="xshift",
2527
Y="yshift",
28+
V="verbos",
2629
Z="type",
2730
c="panel",
2831
l="label",
2932
p="perspective",
33+
t="transparency",
3034
)
3135
@kwargs_to_strings(R="sequence", T="sequence")
3236
def histogram(self, table, **kwargs):
@@ -86,6 +90,14 @@ def histogram(self, table, **kwargs):
8690
[**r**]
8791
Draw a cumulative histogram. Append **r** to instead compute the
8892
reverse cumulative histogram.
93+
extreme : str
94+
**l**\|\ **h**\|\ **b**
95+
The modifiers specify the handling of extreme values that fall outside
96+
the range set by **-T**. By default these values are ignored.
97+
Append **b** to let these values be included in the first or last
98+
bins. To only include extreme values below first bin into the first
99+
bin, use **l**, and to only include extreme values above the last bin
100+
into that last bin, use **h**.
89101
step : bool
90102
Draws a stairs-step diagram which does not include the internal bars
91103
of the default histogram.
@@ -112,6 +124,9 @@ def histogram(self, table, **kwargs):
112124
113125
To use weights provided as a second data column instead of pure counts,
114126
append **+w**.
127+
{U}
128+
{V}
129+
{t}
115130
"""
116131
kwargs = self._preprocess(**kwargs) # pylint: disable=protected-access
117132
with Session() as lib:

0 commit comments

Comments
 (0)