Skip to content

Commit d31ffaf

Browse files
author
Dylan Pulver
committed
DOC: fix docstring parameters that the functions do not accept
ControlPlot.set_plot_title documented `fig`, but the method takes (self, title, frame) and uses self.figure, so there is no way to pass it. The Parameters block came across from suptitle(), which is deprecated in favour of this method and does take fig. phase_plot documented `func`; the parameter was renamed to `odefun`, so the keyword form raised TypeError.
1 parent bfe9380 commit d31ffaf

2 files changed

Lines changed: 1 addition & 3 deletions

File tree

‎control/ctrlplot.py‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -195,8 +195,6 @@ def set_plot_title(self, title, frame='axes'):
195195
----------
196196
title : str
197197
Title text.
198-
fig : Figure, optional
199-
Matplotlib figure. Defaults to current figure.
200198
frame : str, optional
201199
Coordinate frame for centering: 'axes' (default) or 'figure'.
202200
**kwargs : `matplotlib.pyplot.suptitle` keywords, optional

‎control/phaseplot.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1257,7 +1257,7 @@ def phase_plot(odefun, X=None, Y=None, scale=1, X0=None, T=None,
12571257
12581258
Parameters
12591259
----------
1260-
func : callable(x, t, ...)
1260+
odefun : callable(x, t, ...)
12611261
Computes the time derivative of y (compatible with odeint). The
12621262
function should be the same for as used for `scipy.integrate`.
12631263
Namely, it should be a function of the form dx/dt = F(t, x) that

0 commit comments

Comments
 (0)