Update shared axes processing in plot_time_response #1040
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
slivingston
reviewed
Aug 14, 2024
control/freqplot.py
Outdated
| will force the legacy values (mag, phase, omega) to be returned | ||
| (with a warning). To obtain just the frequency response of a system | ||
| (or list of systems) without plotting, use the | ||
| 1. Starting with python-control version 0.10, `bode_plot`returns a |
There was a problem hiding this comment.
Suggested change
| 1. Starting with python-control version 0.10, `bode_plot`returns a | |
| 1. Starting with python-control version 0.10, `bode_plot` returns a |
This space is important because without it, Sphinx fails to parse the :class: expression.
There was a problem hiding this comment.
After fixing this, the PR is ready to merge.
There was a problem hiding this comment.
You may want to commit the figures in the documentation that are affected by this PR.
11 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR updates the way that tickmarks are labeled on shared axes in time response plots, in response to a comment from @slivingston in #1034. Tickmark labels are now omitted on shared axes, consistent with frequency response plots.
To allow tickmark labels to be added, two new keyword arguments are included in
time_response_plot:sharexandsharey. These are passthrough arguments tomatplotlib.pyplot.subplotsand allow axes sharing to be turned on and off in the same way asbode_plot=> frequency and time response plots are now consistent.Also added unit tests checking for consistency and updated the user documentation and relevant docstrings.
sharex=False):