Skip to content

Commit abff9ff

Browse files
committed
DOC: use colons for Axes.pie defaults, etc.
1 parent 2128459 commit abff9ff

File tree

1 file changed

+20
-19
lines changed

1 file changed

+20
-19
lines changed

lib/matplotlib/axes/_axes.py

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2475,7 +2475,8 @@ def pie(self, x, explode=None, labels=None, colors=None,
24752475
startangle=None, radius=None, counterclock=True,
24762476
wedgeprops=None, textprops=None, center=(0, 0),
24772477
frame=False, rotatelabels=False):
2478-
r"""Plot a pie chart.
2478+
r"""
2479+
Plot a pie chart.
24792480
24802481
Make a pie chart of array *x*. The fractional area of each
24812482
wedge is given by ``x/sum(x)``. If ``sum(x) <= 1``, then the
@@ -2488,14 +2489,14 @@ def pie(self, x, explode=None, labels=None, colors=None,
24882489
x : array-like
24892490
The input array used to make the pie chart.
24902491
2491-
explode : array-like, optional (default is None)
2492+
explode : array-like, optional, default: None
24922493
If not *None*, is a ``len(x)`` array which specifies the
24932494
fraction of the radius with which to offset each wedge.
24942495
2495-
labels : list, optional (default is None)
2496+
labels : list, optional, default: None
24962497
A sequence of strings providing the labels for each wedge
24972498
2498-
colors : array-like, optional (default is None)
2499+
colors : array-like, optional, default: None
24992500
A sequence of matplotlib color args through which the pie chart
25002501
will cycle. If `None`, will use the colors in the currently
25012502
active cycle.
@@ -2506,45 +2507,45 @@ def pie(self, x, explode=None, labels=None, colors=None,
25062507
wedge. If it is a format string, the label will be ``fmt%pct``.
25072508
If it is a function, it will be called.
25082509
2509-
pctdistance : float, optional (default is 0.6)
2510+
pctdistance : float, optional, default: 0.6
25102511
The ratio between the center of each pie slice and the
25112512
start of the text generated by *autopct*. Ignored if
2512-
*autopct* is *None*; default is 0.6.
2513+
*autopct* is *None*.
25132514
2514-
shadow : bool, optional (default is False)
2515+
shadow : bool, optional, default: False
25152516
Draw a shadow beneath the pie.
25162517
2517-
labeldistance : float, optional (default is 1.1)
2518+
labeldistance : float, optional, default: 1.1
25182519
The radial distance at which the pie labels are drawn
25192520
2520-
startangle : float, optional (default is None)
2521+
startangle : float, optional, default: None
25212522
If not *None*, rotates the start of the pie chart by *angle*
25222523
degrees counterclockwise from the x-axis.
25232524
2524-
radius : float, optional (default is None)
2525+
radius : float, optional, default: None
25252526
The radius of the pie, if *radius* is *None* it will be set to 1.
25262527
2527-
counterclock : bool, optional (default is True)
2528+
counterclock : bool, optional, default: True
25282529
Specify fractions direction, clockwise or counterclockwise.
25292530
2530-
wedgeprops : dict, optional (default is None)
2531+
wedgeprops : dict, optional, default: None
25312532
Dict of arguments passed to the wedge objects making the pie.
25322533
For example, you can pass in``wedgeprops = {'linewidth': 3}``
25332534
to set the width of the wedge border lines equal to 3.
25342535
For more details, look at the doc/arguments of the wedge object.
25352536
By default ``clip_on=False``.
25362537
2537-
textprops : dict, optional (default is None)
2538+
textprops : dict, optional, default: None
25382539
Dict of arguments to pass to the text objects.
25392540
2540-
center : list of float, optional (default is (0, 0))
2541+
center : list of float, optional, default: (0, 0)
25412542
Center position of the chart. Takes value (0, 0) or is a
25422543
sequence of 2 scalars.
25432544
2544-
frame : bool, optional (default is False)
2545+
frame : bool, optional, default: False
25452546
Plot axes frame with the chart if true.
25462547
2547-
rotatelabels : bool, optional (default is False)
2548+
rotatelabels : bool, optional, default: False
25482549
Rotate each label to the angle of the corresponding slice if true.
25492550
25502551
Returns
@@ -2558,7 +2559,7 @@ def pie(self, x, explode=None, labels=None, colors=None,
25582559
autotexts : list
25592560
A is a list of :class:`~matplotlib.text.Text` instances for the
25602561
numeric labels. Is returned only if parameter *autopct* is
2561-
not *None*.
2562+
not *None*.
25622563
25632564
Notes
25642565
-----
@@ -2684,9 +2685,9 @@ def get_next_color():
26842685
self.set_frame_on(False)
26852686

26862687
self.set_xlim((-1.25 + center[0],
2687-
1.25 + center[0]))
2688+
1.25 + center[0]))
26882689
self.set_ylim((-1.25 + center[1],
2689-
1.25 + center[1]))
2690+
1.25 + center[1]))
26902691
self.set_xticks([])
26912692
self.set_yticks([])
26922693

0 commit comments

Comments
 (0)