Skip to content

Readthedocs issues to be fixed #358

Description

@murrayrm

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)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions