Skip to content

Readthedocs issues to be fixed #358

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
murrayrm opened this issue Dec 31, 2019 · 1 comment
Closed

Readthedocs issues to be fixed #358

murrayrm opened this issue Dec 31, 2019 · 1 comment
Milestone

Comments

@murrayrm
Copy link
Member

In looking through the readthedocs documentation for python-control, there are a number of small items that need to be fixed:

  • In the various plotting commands that allow positional and keyword arguments to be passed to matplotlib, the documentation lists the arguments as "**kwargs(*args,)" instead of "*args, **kwargs" (example).

  • The documentation for parallel lists the second argument as *sysn while the documentation for series lists the second argument as sysn. In both cases, a list of additional functions is allowed.

  • In the documentation for phase_plot, the various possibilities for lingrid are showing up as = N or (N, M) (lingrid) instead of lingrid = N or (N, M).

Also, I'm not sure if this is fixable but the formatting of strings in Jupyter/ipython has extra backslash characters in various places. For example, the bode_plot documentation says

\*args, \*\*kwargs:
    Additional options to matplotlib (color, linestyle, etc)
murrayrm added a commit to murrayrm/python-control that referenced this issue Jan 1, 2020
murrayrm added a commit to murrayrm/python-control that referenced this issue Jan 1, 2020
murrayrm added a commit to murrayrm/python-control that referenced this issue Jan 1, 2020
@murrayrm murrayrm added this to the 0.8.3 milestone Jan 3, 2020
@murrayrm
Copy link
Member Author

murrayrm commented Jan 3, 2020

Fixed in PR #360.

@murrayrm murrayrm closed this as completed Jan 3, 2020
murrayrm added a commit that referenced this issue Jan 4, 2020
* add info on methods for time responses
* add script and Jupyter notebook examples to documentation
* updated I/O systems documentation (with example)
* fix *args, *kwargs*  in freqplot docstrings to fix issue #358
* update series() and paralle() docstrings to fix issue #358
* fix docstring for phase_plot of fix issue #358
repagh pushed a commit to repagh/python-control that referenced this issue Jun 9, 2020
* add info on methods for time responses
* add script and Jupyter notebook examples to documentation
* updated I/O systems documentation (with example)
* fix *args, *kwargs*  in freqplot docstrings to fix issue python-control#358
* update series() and paralle() docstrings to fix issue python-control#358
* fix docstring for phase_plot of fix issue python-control#358
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant