Commiteea529e

committed

Improve docs regarding plt.close().

1 parentdc05767 commiteea529eCopy full SHA for eea529e

File tree

+10

-1

lines changed

+10

-1

lines changed

Lines changed: 1 addition & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -287,6 +287,7 @@ the desired format::`
`287`	`287`	`import matplotlib.pyplot as plt`
`288`	`288`	`plt.plot([1, 2, 3])`
`289`	`289`	`plt.savefig('myfig.png')`
	`290`	`+ plt.close()`
`290`	`291`
`291`	`292`	`..seealso::`
`292`	`293`

Lines changed: 9 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -1172,7 +1172,7 @@ def disconnect(cid: int) -> None:`
`1172`	`1172`
`1173`	`1173`	`defclose(fig:None\|int\|str\|Figure\|Literal["all"]=None)->None:`
`1174`	`1174`	`"""`
`1175`		`- Close a figure window.`
	`1175`	`+ Close a figure window, and unregister it from pyplot.`
`1176`	`1176`
`1177`	`1177`	`Parameters`
`1178`	`1178`	`----------`
`@@ -1185,6 +1185,14 @@ def close(fig: None \| int \| str \| Figure \| Literal["all"] = None) -> None:`
`1185`	`1185`	- ``str``: a figure name
`1186`	`1186`	`- 'all': all figures`
`1187`	`1187`
	`1188`	`+ Notes`
	`1189`	`+ -----`
	`1190`	+ pyplot maintains a reference to figures created with `figure()`. When
	`1191`	`+ work on the figure is completed, it should be closed, i.e. deregistered`
	`1192`	`+ from pyplot, to free its memory (see also :rc:figure.max_open_warning).`
	`1193`	+ Closing a figure window created by `show()` automatically deregisters the
	`1194`	+ figure. For all other use cases, most prominently `savefig()` without
	`1195`	+ `show()`, the figure must be deregistered explicitly using `close()`.
`1188`	`1196`	`"""`
`1189`	`1197`	`iffigisNone:`
`1190`	`1198`	`manager=_pylab_helpers.Gcf.get_active()`

Comments

(0)