@@ -1311,16 +1311,23 @@ def use(arg, warn=True, force=False):
1311
1311
"""
1312
1312
Set the matplotlib backend to one of the known backends.
1313
1313
1314
- To find out which backend is currently set, see
1315
- :func:`matplotlib.get_backend`.
1316
-
1317
-
1318
1314
Parameters
1319
1315
----------
1320
1316
arg : str
1321
1317
The backend to switch to. This can either be one of the
1322
- 'standard' backend names or a string of the form
1323
- ``module://my.module.name``. This value is case-insensitive.
1318
+ 'standard' backend names:
1319
+
1320
+ - interactive backends:
1321
+ GTK3Agg, GTK3Cairo, MacOSX, nbAgg,
1322
+ Qt4Agg, Qt4Cairo, Qt5Agg, Qt5Cairo,
1323
+ TkAgg, TkCairo, WebAgg, WX, WXAgg, WXCairo
1324
+
1325
+ - non-interactive backends:
1326
+ agg, cairo, pdf, pgf, ps, svg, template
1327
+
1328
+ or a string of the form: ``module://my.module.name``.
1329
+
1330
+ This value is case-insensitive.
1324
1331
1325
1332
warn : bool, optional
1326
1333
If True, warn if this is called after pyplot has been imported
@@ -1332,7 +1339,10 @@ def use(arg, warn=True, force=False):
1332
1339
If True, attempt to switch the backend. This defaults to
1333
1340
False.
1334
1341
1335
-
1342
+ See Also
1343
+ --------
1344
+ :ref:`backends`
1345
+ matplotlib.get_backend
1336
1346
"""
1337
1347
name = validate_backend (arg )
1338
1348
@@ -1371,7 +1381,13 @@ def use(arg, warn=True, force=False):
1371
1381
1372
1382
1373
1383
def get_backend ():
1374
- """Return the name of the current backend."""
1384
+ """
1385
+ Return the name of the current backend.
1386
+
1387
+ See Also
1388
+ --------
1389
+ matplotlib.use
1390
+ """
1375
1391
return rcParams ['backend' ]
1376
1392
1377
1393
0 commit comments