Skip to content

Commit 696e871

Browse files
committed
minor doc cleanups
1 parent 528026a commit 696e871

File tree

3 files changed

+9
-6
lines changed

3 files changed

+9
-6
lines changed

probscale/formatters.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ def _sig_figs(cls, x, n, expthresh=5, forceint=False):
3030
Examples
3131
--------
3232
>>> print(_sig_figs(1247.15, 3))
33-
1250
33+
'1250'
3434
>>> print(_sig_figs(1247.15, 7))
35-
1247.150
35+
'1247.150'
3636
3737
"""
3838

@@ -121,7 +121,7 @@ class ProbFormatter(_FormatterMixin):
121121
>>> from probscale import formatters
122122
>>> fmt = formatters.ProbFormatter()
123123
>>> fmt(0.01)
124-
'0,01'
124+
'0.01'
125125
>>> fmt(0.2)
126126
'0.20'
127127
>>> try:

probscale/probscale.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ class ProbScale(ScaleBase):
8585
>>> from matplotlib import pyplot
8686
>>> import probscale
8787
>>> fig, ax = pyplot.subplots()
88-
>>> ax.set_ylim(bottom=0.2, top=99.9)
88+
>>> ax.set_ylim(bottom=0.2, top=99.8)
8989
>>> ax.set_yscale('prob')
9090
9191
"""

probscale/viz.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,12 @@ def probplot(data, ax=None, plottype='prob', dist=None, probax='x',
2121
The Axes on which to plot. If one is not provided, a new Axes
2222
will be created.
2323
plottype : string (default = 'prob')
24-
Type of plot to be created. Options are:
24+
Type of plot to be created. Options are:
25+
2526
- 'prob': probabilty plot
2627
- 'pp': percentile plot
2728
- 'qq': quantile plot
29+
2830
dist : scipy distribution, optional
2931
A distribtion to compute the scale's tick positions. If not
3032
specified, a standard normal distribution will be used.
@@ -67,7 +69,8 @@ def probplot(data, ax=None, plottype='prob', dist=None, probax='x',
6769
fig : matplotlib.Figure
6870
The figure on which the plot was drawn.
6971
result : dictionary of linear fit results, optional
70-
Keys are:
72+
Keys are:
73+
7174
- q : array of quantiles
7275
- x, y : arrays of data passed to function
7376
- xhat, yhat : arrays of modeled data plotted in best-fit line

0 commit comments

Comments
 (0)