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 — DOC: fix docstring parameters that the functions do not accept by dylanpulver · Pull Request #1274 · python-control/python-control ConversationTwo Parameters entries name an argument the function does not take.
One thing I did not change, because it is your call rather than mine. The same block documents Docstrings only.
Sorry, something went wrong. Uh oh!
There was an error while loading. Please reload this page. All reactions
slivingston
requested changes
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Sorry, something went wrong. Uh oh!
There was an error while loading. Please reload this page. All reactions
Member
All reactions
Sorry, something went wrong. Uh oh!
There was an error while loading. Please reload this page. ControlPlot.set_plot_title documented `fig`, but the method takes (self, title, frame) and uses self.figure, so there is no way to pass it. The Parameters block came across from suptitle(), which is deprecated in favour of this method and does take fig. phase_plot documented `func`; the parameter was renamed to `odefun`, so the keyword form raised TypeError. Per review: the passthrough was never dropped, it is simply not reachable through ControlPlot.set_plot_title. _update_plot_title is called from outside this module with arguments that land in **kwargs, so that is where the description belongs. It had no docstring, so the entries for its other parameters come from the module: fig from `if fig is None: fig = plt.gcf()`, frame from the wording already used in set_plot_title, and use_existing from the title-merging branch below.
dylanpulver
force-pushed
the
doc/phantom-parameter-names
branch
from
d31ffaf to
ec4fd52
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
ReviewersUh oh!
There was an error while loading. Please reload this page. AssigneesNo one assignedLabels
None yet
ProjectsMilestoneNo milestoneDevelopmentSuccessfully merging this pull request may close these issues. Uh oh!
There was an error while loading. Please reload this page. 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. |