Skip to content

Commit 3883c79

Browse files
committed
Cleanup some parameter descriptions in matplotlibrc.template
1 parent 1636987 commit 3883c79

File tree

1 file changed

+21
-22
lines changed

1 file changed

+21
-22
lines changed

matplotlibrc.template

Lines changed: 21 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@
100100
#backend_fallback : True
101101

102102
#interactive : False
103-
#toolbar : toolbar2 ## None | toolbar2 ("classic" is deprecated)
103+
#toolbar : toolbar2 ## {None, toolbar2}
104104
#timezone : UTC ## a pytz timezone string, e.g., US/Central or Europe/Paris
105105

106106
## Where your matplotlib data lives if you installed to a non-default
@@ -121,10 +121,10 @@
121121
#lines.markeredgecolor : auto ## the default marker edge color
122122
#lines.markeredgewidth : 1.0 ## the line width around the marker symbol
123123
#lines.markersize : 6 ## marker size, in points
124-
#lines.dash_joinstyle : round ## miter | round | bevel
125-
#lines.dash_capstyle : butt ## butt | round | projecting
126-
#lines.solid_joinstyle : round ## miter | round | bevel
127-
#lines.solid_capstyle : projecting ## butt | round | projecting
124+
#lines.dash_joinstyle : round ## {miter, round, bevel}
125+
#lines.dash_capstyle : butt ## {butt, round, projecting}
126+
#lines.solid_joinstyle : round ## {miter, round, bevel}
127+
#lines.solid_capstyle : projecting ## {butt, round, projecting}
128128
#lines.antialiased : True ## render lines in antialiased (no jaggies)
129129

130130
## The three standard dash patterns. These are scaled by the linewidth.
@@ -133,7 +133,7 @@
133133
#lines.dotted_pattern : 1, 1.65
134134
#lines.scale_dashes : True
135135

136-
#markers.fillstyle : full ## full|left|right|bottom|top|none
136+
#markers.fillstyle : full ## {full, left, right, bottom, top, none}
137137

138138

139139
## ***************************************************************************
@@ -354,9 +354,8 @@
354354
#axes.linewidth : 0.8 ## edge linewidth
355355
#axes.grid : False ## display grid or not
356356
#axes.grid.axis : both ## which axis the grid should apply to
357-
#axes.grid.which : major ## gridlines at major, minor or both ticks
358-
#axes.titlelocation : center ## alignment of the title, possible values are:
359-
## left, right and center
357+
#axes.grid.which : major ## gridlines at {major, minor, both} ticks
358+
#axes.titlelocation : center ## alignment of the title: {left, right, center}
360359
#axes.titlesize : large ## fontsize of the axes title
361360
#axes.titleweight : normal ## font weight of title
362361
#axes.titlepad : 6.0 ## pad between axes and title in points
@@ -400,8 +399,9 @@
400399
#axes.prop_cycle : cycler('color', ['1f77b4', 'ff7f0e', '2ca02c', 'd62728', '9467bd', '8c564b', 'e377c2', '7f7f7f', 'bcbd22', '17becf'])
401400
## color cycle for plot lines as list of string colorspecs:
402401
## single letter, long name, or web-style hex
403-
## Note the use of string escapes here ('1f77b4', instead of 1f77b4)
404-
## as opposed to the rest of this file.
402+
## As opposed to all other paramters in this file, the color
403+
## values must be enclosed in quotes for this parameter,
404+
# e.g. '1f77b4', instead of 1f77b4.
405405
## See also https://matplotlib.org/tutorials/intermediate/color_cycle.html
406406
## for more details on prop_cycle usage.
407407
#axes.autolimit_mode : data ## How to scale axes limits to the data. By using:
@@ -450,7 +450,7 @@
450450
#xtick.minor.pad : 3.4 ## distance to the minor tick label in points
451451
#xtick.color : black ## color of the tick labels
452452
#xtick.labelsize : medium ## fontsize of the tick labels
453-
#xtick.direction : out ## direction: in, out, or inout
453+
#xtick.direction : out ## direction: {in, out, inout}
454454
#xtick.minor.visible : False ## visibility of minor ticks on x-axis
455455
#xtick.major.top : True ## draw x axis top major ticks
456456
#xtick.major.bottom : True ## draw x axis bottom major ticks
@@ -470,7 +470,7 @@
470470
#ytick.minor.pad : 3.4 ## distance to the minor tick label in points
471471
#ytick.color : black ## color of the tick labels
472472
#ytick.labelsize : medium ## fontsize of the tick labels
473-
#ytick.direction : out ## direction: in, out, or inout
473+
#ytick.direction : out ## direction: {in, out, inout}
474474
#ytick.minor.visible : False ## visibility of minor ticks on y-axis
475475
#ytick.major.left : True ## draw y axis left major ticks
476476
#ytick.major.right : True ## draw y axis right major ticks
@@ -556,11 +556,11 @@
556556
## ***************************************************************************
557557
## * IMAGES *
558558
## ***************************************************************************
559-
#image.aspect : equal ## equal | auto | a number
559+
#image.aspect : equal ## {equal, auto} or a number
560560
#image.interpolation : nearest ## see help(imshow) for options
561561
#image.cmap : viridis ## A colormap name, gray etc...
562562
#image.lut : 256 ## the size of the colormap lookup table
563-
#image.origin : upper ## lower | upper
563+
#image.origin : upper ## {lower, upper}
564564
#image.resample : True
565565
#image.composite_image : True ## When True, all the images on a set of axes are
566566
## combined into a single composite image before
@@ -572,7 +572,7 @@
572572
## * CONTOUR PLOTS *
573573
## ***************************************************************************
574574
#contour.negative_linestyle : dashed ## string or on-off ink sequence
575-
#contour.corner_mask : True ## True | False | legacy
575+
#contour.corner_mask : True ## {True, False, legacy}
576576

577577

578578
## ***************************************************************************
@@ -584,8 +584,7 @@
584584
## ***************************************************************************
585585
## * HISTOGRAM PLOTS *
586586
## ***************************************************************************
587-
#hist.bins : 10 ## The default number of histogram bins.
588-
## If Numpy 1.11 or later is installed, may also be `auto`
587+
#hist.bins : 10 ## The default number of histogram bins or 'auto'.
589588

590589

591590
## ***************************************************************************
@@ -641,8 +640,8 @@
641640
#savefig.dpi : figure ## figure dots per inch or 'figure'
642641
#savefig.facecolor : white ## figure facecolor when saving
643642
#savefig.edgecolor : white ## figure edgecolor when saving
644-
#savefig.format : png ## png, ps, pdf, svg
645-
#savefig.bbox : standard ## 'tight' or 'standard'.
643+
#savefig.format : png ## {png, ps, pdf, svg}
644+
#savefig.bbox : standard ## {tight, standard}
646645
## 'tight' is incompatible with pipe-based animation
647646
## backends but will workd with temporary file based ones:
648647
## e.g. setting animation.writer to ffmpeg will not work,
@@ -659,9 +658,9 @@
659658
#tk.window_focus : False ## Maintain shell focus for TkAgg
660659

661660
### ps backend params
662-
#ps.papersize : letter ## auto, letter, legal, ledger, A0-A10, B0-B10
661+
#ps.papersize : letter ## {auto, letter, legal, ledger, A0-A10, B0-B10}
663662
#ps.useafm : False ## use of afm fonts, results in small files
664-
#ps.usedistiller : False ## can be: None, ghostscript or xpdf
663+
#ps.usedistiller : False ## {ghostscript, xpdf, None}
665664
## Experimental: may produce smaller files.
666665
## xpdf intended for production of publication quality files,
667666
## but requires ghostscript, xpdf and ps2eps

0 commit comments

Comments
 (0)