GeezerVison

The World Wide Web, restored to 800 pixels of glory.

GeezerVison is showing github.com — DOC: fix docstring parameters that the functions do not accept by dylanpulver · Pull Request #1274 · python-control/python-control

DOC: fix docstring parameters that the functions do not accept #1274

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open

dylanpulver wants to merge 2 commits into python-control:main

base: main

from dylanpulver:doc/phantom-parameter-names

+18 −5

Open

DOC: fix docstring parameters that the functions do not accept #1274

Show file tree

Hide file tree

Changes from all commits

Commits

Show all changes

2 commits

Select commit Hold shift + click to select a range

9bad931

DOC: fix docstring parameters that the functions do not accept

dylanpulver Nov 13, 2026

ec4fd52

DOC: move the **kwargs description to _update_plot_title

dylanpulver Nov 13, 2026

File filter

Filter by extension .py (2) All 1 file type selected

Viewed files

Clear filters

Conversations

Failed to load comments.

Uh oh!

There was an error while loading. Please reload this page.

Jump to

Jump to file

Failed to load files.

Uh oh!

There was an error while loading. Please reload this page.

Diff view

Unified

Split

Hide whitespace

Diff view

Unified

Split

Hide whitespace

There are no files selected for viewing

21 changes: 17 additions & 4 deletions 21 control/ctrlplot.py

Show comments

View file

Open in desktop

Original file line number	Diff line number	Diff line change
Expand Up		@@ -195,12 +195,8 @@ def set_plot_title(self, title, frame='axes'):
		----------
		title : str
		Title text.
		fig : Figure, optional
		Matplotlib figure. Defaults to current figure.
		frame : str, optional
		Coordinate frame for centering: 'axes' (default) or 'figure'.
		**kwargs : `matplotlib.pyplot.suptitle` keywords, optional
		Additional keywords (passed to matplotlib).

		"""
		_update_plot_title(
Expand Down Expand Up		@@ -540,6 +536,23 @@ def _make_legend_labels(labels, ignore_common=False):

		def _update_plot_title(
		title, fig=None, frame='axes', use_existing=True, **kwargs):
		"""Set or extend the centered title of a figure.

		Parameters
		----------
		title : str
		Title text.
		fig : Figure, optional
		Matplotlib figure. Defaults to the current figure.
		frame : str, optional
		Coordinate frame for centering: 'axes' (default) or 'figure'.
		use_existing : bool, optional
		If True (default), extend the figure's existing title instead of
		replacing it.
		**kwargs : `matplotlib.pyplot.suptitle` keywords, optional
		Additional keywords (passed to matplotlib).

		"""
		if title is False or title is None:
		return
		if fig is None:
Expand Down

2 changes: 1 addition & 1 deletion 2 control/phaseplot.py

Show comments

View file

Open in desktop

Original file line number	Diff line number	Diff line change
Expand Up		@@ -1257,7 +1257,7 @@ def phase_plot(odefun, X=None, Y=None, scale=1, X0=None, T=None,

		Parameters
		----------
		func : callable(x, t, ...)
		odefun : callable(x, t, ...)
		Computes the time derivative of y (compatible with odeint). The
		function should be the same for as used for `scipy.integrate`.
		Namely, it should be a function of the form dx/dt = F(t, x) that
Expand Down

Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.

You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.