Skip to content

Commit 5a6f326

Browse files
committed
reorder params in probplot docstring [ci skip]
1 parent 797fc84 commit 5a6f326

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

probscale/viz.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,31 +26,31 @@ def probplot(data, ax=None, axtype='prob', dist=None, probax='x',
2626
dist : scipy distribution, optional
2727
A distribtion to compute the scale's tick positions. If not
2828
specified, a normal distribution will be used.
29+
probax : string, optional (default = 'x')
30+
The axis ('x' or 'y') that will serve as the probability (or
31+
quantile) axis.
2932
color : valid matplotlib color specification, optional
3033
If provided, this value will be added to the ``scatter_kws``
3134
and ``line_kws`` dictionary under the "color" key.
3235
label : string, optional
3336
If provided, this legend label is applied to the scatter series
3437
of the probability plot.
35-
probax : string, optional (default = 'x')
36-
The axis ('x' or 'y') that will serve as the probability (or
37-
quantile) axis.
3838
otherscale : string, optional (default = 'log')
3939
Scale for the other axis that is not
4040
xlabel, ylabel : string, optional
4141
Axis labels for the plot.
4242
bestfit : bool, optional (default is False)
4343
Specifies whether a best-fit line should be added to the
4444
plot.
45+
return_results : bool (default = False)
46+
If True a dictionary of results of is returned along with the
47+
figure.
4548
scatter_kws, line_kws : dictionary, optional
4649
Dictionary of keyword arguments passed directly to ``ax.plot``
4750
when drawing the scatter points and best-fit line, respectively.
4851
pp_kws : dictionary, optional
4952
Dictionary of keyword arguments passed directly to
5053
``viz.plot_pos``.
51-
return_results : bool (default = False)
52-
If True a dictionary of results of is returned along with the
53-
figure.
5454
5555
Returns
5656
-------

0 commit comments

Comments
 (0)