Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Version 0.10.2 release notes#1140

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged

Conversation

@murrayrm
Copy link
Member

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).

@murrayrmmurrayrm added this to the0.10.2 milestoneMar 8, 2025
@coveralls
Copy link

coveralls commentedMar 8, 2025•
edited
Loading

Coverage Status

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

Copy link
Contributor

@roryyorkeroryyorke 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.

3types typos, one tentative wording suggestion.

@murrayrmmurrayrmforce-pushed therelease_notes-07Mar2025 branch from67c1e66 to7548738CompareMarch 8, 2025 17:40
@slivingstonslivingston self-requested a reviewMarch 10, 2025 16:29
Copy link
Contributor

@bnavigatorbnavigator left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@slivingstonslivingston 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:

* `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

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

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

@murrayrmmurrayrmMar 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

slivingston reacted with thumbs up emoji
@murrayrm
Copy link
MemberAuthor

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.

@slivingston
Copy link
Member

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.

@murrayrm
Copy link
MemberAuthor

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

@slivingston
Copy link
Member

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

@murrayrmmurrayrmforce-pushed therelease_notes-07Mar2025 branch fromcd03df9 tob3d8ce9CompareJuly 4, 2025 16:14
@murrayrmmurrayrm merged commit03ae372 intopython-control:mainJul 4, 2025
24 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

@slivingstonslivingstonslivingston approved these changes

@bnavigatorbnavigatorbnavigator approved these changes

+1 more reviewer

@roryyorkeroryyorkeroryyorke requested changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

0.10.2

Development

Successfully merging this pull request may close these issues.

5 participants

@murrayrm@coveralls@slivingston@roryyorke@bnavigator
[8]ページ先頭
©2009-2025 Movatter.jp