This PR contains release notes for version 0.10.2 of the python-control toolbox. This should be the last PR merged before release v0.10.2 (with addition commits if any new functionality is added via other PRs).

murrayrm added this to the0.10.2 milestone

Mar 8, 2025

Copy link

coveralls commentedMar 8, 2025•
edited
Loading

coverage: 94.745%. remained the same
when pullingcd03df9 on murrayrm:release_notes-07Mar2025
intoad996f9 on python-control:main.

roryyorke suggested changes

Mar 8, 2025

View reviewed changes

Copy link

Contributor

roryyorke left a comment•
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

3~~types~~ typos, one tentative wording suggestion.

doc/releases/0.10.2-notes.rst OutdatedShow resolvedHide resolved

murrayrm added3 commits

March 8, 2025 09:30

first pass at 0.10.2 release notes

36530c8

add NamedSignal documentation + tweak control classes figure

e440b6f

fix typos pointed out by@roryyorke

7548738

murrayrm force-pushed therelease_notes-07Mar2025 branch from67c1e66 to7548738Compare

March 8, 2025 17:40

slivingston self-requested a review

March 10, 2025 16:29

bnavigator approved these changes

Mar 14, 2025

View reviewed changes

Copy link

Contributor

bnavigator left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

LGTM

slivingston reviewed

Mar 14, 2025

View reviewed changes

Copy link

Member

slivingston left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Excellent!

Not related to this PR but relevant in terms of the docs:pinning docutils at 0.16 is not necessary now because thecurrent sphinx_rtd_theme release is compatible with later versions. I removed the pin from requirements.txt and locally the result looks good to me, though I did not carefully compare it side-by-side with the current case (of docutils pinned at 0.16). If you think this is too risky to do now, OK to wait and make the change after releasing version 0.10.2.

If you have access to the ReadTheDocs admin panel, it is worth checking why a warning banner is not appearing on older versions,as I commented in a recent issue.

While reviewing, I noticed a misprint in the docs: "indexed indexed" appears twice in timeresp.py:

python-control/control/timeresp.py
Line 554 in394e1c2
Time evolution of the state vector, indexed indexed by either the
python-control/control/timeresp.py
Line 619 in394e1c2
Time evolution of the state vector, indexed indexed by either the

doc/releases/0.10.2-notes.rst OutdatedShow resolvedHide resolved

doc/releases/0.10.2-notes.rst Outdated

		* `FrequencyResponseData`: use `~FrequencyResponseData.complex` to
		access the (squeeze processed) complex frequency response (instead
		of the legacy `response` property) and
		`~FrequencyResponseData.frdata` to access the 3D frequency response

Copy link

Member

slivingstonMar 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

This does not render as a link tofrdata for me when I build locally. This is expected becausefrdata is an attribute,whereascomplex is a property. Attributes defined by assignment toself do not have documentation besides the class docstring, whereas the property definitions are functions and thus can have their own docstrings.

You might already be aware of the above, but I wanted to write it out to share my understanding while reviewing this PR.

Copy link

Member

slivingstonMar 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Consider changing this to

`FrequencyResponseData.frdata <FrequencyResponseData>`

as it is written in the "Deprecations" section below.

Copy link

MemberAuthor

murrayrmMar 15, 2025•
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I've made the proposed change, but for future we might consider documenting attributes. This can be done by defining the attribute in the class and using the#: syntax in Sphinx. So something like this:

class FrequencyReponseData():    ...    #: Frequency response data array.    #:    #: The frequency response at each frequency point.  If 1D, ...    frdata = None

doc/classes.rst OutdatedShow resolvedHide resolved

Copy link

MemberAuthor

murrayrm commentedMar 15, 2025

If you have access to the ReadTheDocs admin panel, it is worth checking why a warning banner is not appearing on older versions,#1131 (comment)

I looked into this and the settings are such that we should see warning banners. But we don't. I've added@slivingston as a maintainer in case you have time to look and want to debug.

address@slivingstonreview + other small fixes, cleanup

9d33e1f

Copy link

Member

slivingston commentedMar 15, 2025

If you have access to the ReadTheDocs admin panel, it is worth checking why a warning banner is not appearing on older versions,#1131 (comment)
I looked into this and the settings are such that we should see warning banners. But we don't. I've added@slivingston as a maintainer in case you have time to look and want to debug.

Thanks. It turns out that ReadTheDocs follows the Semantic Version specification, which states that versions less than 1.0.0 are for "initial development" and not stable. ReadTheDocs allows us to manually declare which version is stable by pushing a branch namedstable, which I did. Now viewing older versions or "latest" (!= stable) shows warning banners as we want.

slivingston approved these changes

Mar 15, 2025

View reviewed changes

Copy link

MemberAuthor

murrayrm commentedMar 15, 2025

Thanks for the ReadTheDocs fix,@slivingston. What do we need to do when we make a new release? Copy that release into stable?

Copy link

Member

slivingston commentedMar 15, 2025

Thanks for the ReadTheDocs fix,@slivingston. What do we need to do when we make a new release? Copy that release into stable?

Yes. Basically, the branch should point to the same commit as the tag used for the release:

git checkout stablegit merge 0.10.2git push

murrayrm added2 commits

June 21, 2025 15:38

added notes on latest changes for this release

5aef9cc

add disk_margins to release notes

cd03df9

Labels

None yet

5 participants

Movatterモバイル変換

Version 0.10.2 release notes#1140

Are you sure you want to change the base?

Version 0.10.2 release notes#1140

Uh oh!

Conversation

murrayrm commentedMar 8, 2025

Uh oh!

coveralls commentedMar 8, 2025• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Uh oh!

roryyorke left a comment• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bnavigator left a comment

Choose a reason for hiding this comment

Uh oh!

slivingston left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

slivingstonMar 14, 2025

Choose a reason for hiding this comment

Uh oh!

slivingstonMar 14, 2025

Choose a reason for hiding this comment

Uh oh!

murrayrmMar 15, 2025• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

murrayrm commentedMar 15, 2025

Uh oh!

slivingston commentedMar 15, 2025

Uh oh!

murrayrm commentedMar 15, 2025

Uh oh!

slivingston commentedMar 15, 2025

Uh oh!

Uh oh!

coveralls commentedMar 8, 2025•
edited
Loading

roryyorke left a comment•
edited
Loading

murrayrmMar 15, 2025•
edited
Loading