GeezerVisonThe World Wide Web, restored to 800 pixels of glory. | |||||||||||||||||||||
| Home|About|Gaming cabinet|Archives|How it works|Starter sites | |||||||||||||||||||||
GeezerVison is showing github.com — Version 0.10.2 release notes by murrayrm · Pull Request #1140 · python-control/python-control Conversation
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).
Sorry, something went wrong. Uh oh!
There was an error while loading. Please reload this page. All reactions
|
There was an error while loading. Please reload this page.
|
coverage: 94.745%. remained the same |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
3 types typos, one tentative wording suggestion.
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
67c1e66 to
7548738
Compare
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem 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 the current 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 in 394e1c2
| Time evolution of the state vector, indexed indexed by either the |
python-control/control/timeresp.py
Line 619 in 394e1c2
| Time evolution of the state vector, indexed indexed by either the |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
| * `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 |
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
This does not render as a link to frdata for me when I build locally. This is expected because frdata is an attribute, whereas complex is a property. Attributes defined by assignment to self 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.
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem 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.
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was a problem 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
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
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. |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
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 named |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
|
Thanks for the ReadTheDocs fix, @slivingston. What do we need to do when we make a new release? Copy that release into stable? |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
Yes. Basically, the branch should point to the same commit as the tag used for the release: |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
cd03df9 to
b3d8ce9
Compare
There was an error while loading. Please reload this page.
Successfully merging this pull request may close these issues.
There was an error while loading. Please reload this page.