Skip to content

Commit 2d2df08

Browse files
committed
add docstring for step, type
1 parent a1ea5a3 commit 2d2df08

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

pygmt/src/histogram.py

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,8 +84,11 @@ def histogram(self, table, **kwargs):
8484
instead.
8585
cumulative : bool or str
8686
[**r**]
87-
raw a cumulative histogram. Append **r** to instead compute the
87+
Draw a cumulative histogram. Append **r** to instead compute the
8888
reverse cumulative histogram.
89+
step : bool
90+
Draws a stairs-step diagram which does not include the internal bars
91+
of the default histogram.
8992
label : str
9093
Add a legend entry for the symbol or line being plotted.
9194
{p}
@@ -95,7 +98,20 @@ def histogram(self, table, **kwargs):
9598
series : int or str or list
9699
[*min*\ /*max*\ /]\ *inc*\ [**+n**\ ]
97100
Set the interval for the width of each bar in the histogram.
101+
{XY}
102+
type : int or str
103+
[*type*][**+w**]
104+
Choose between 6 types of histograms:
98105
106+
* 0 = counts [Default]
107+
* 1 = frequency_percent
108+
* 2 = log (1.0 + count)
109+
* 3 = log (1.0 + frequency_percent)
110+
* 4 = log10 (1.0 + count)
111+
* 5 = log10 (1.0 + frequency_percent).
112+
113+
To use weights provided as a second data column instead of pure counts,
114+
append **+w**.
99115
"""
100116
kwargs = self._preprocess(**kwargs) # pylint: disable=protected-access
101117
with Session() as lib:

0 commit comments

Comments
 (0)