Skip to content

Small documentation updates #123

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

Merged
merged 10 commits into from
Dec 31, 2016
Merged

Conversation

murrayrm
Copy link
Member

This PR includes some small updates to the python-control documentation, including updating the path for Slycot, adding some entries for missing functions, and adding a new "conventions" section.

@coveralls
Copy link

coveralls commented Dec 27, 2016

Coverage Status

Changes Unknown when pulling 303480f on murrayrm:doc-update into ** on python-control:master**.

@coveralls
Copy link

coveralls commented Dec 27, 2016

Coverage Status

Changes Unknown when pulling 93b50b1 on murrayrm:doc-update into ** on python-control:master**.

@coveralls
Copy link

coveralls commented Dec 29, 2016

Coverage Status

Changes Unknown when pulling 349025b on murrayrm:doc-update into ** on python-control:master**.

@slivingston slivingston self-assigned this Dec 31, 2016
@slivingston
Copy link
Member

From commit 1f15678, names from control.robust are copied into the top-level (i.e., control) of the package. This is the only set of changes of this PR that involves more than documentation.

I think that the change is reasonable because there have not been collisions among desired names of function or classes (at least, not that I am aware of). Furthermore, the change is consistent with the current pattern of organization.

@murrayrm
Copy link
Member Author

The change in __init.py__ in commit 1f15678 was actually required in order to get those functions to show up properly in the documentation. So while it has impact beyond documentation, there is a reason that it was included in this PR.

`lapack` library. More information on the slycot package can be obtained
from the `slycot project page <https://github.com/python-control/Slycot>`_.

For users with a working the Anaconda distribution of Python, the following
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be "...with the Anaconda distribution..."?

@murrayrm If you agree, I can merge and then delete the words "a working".

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The change is trivial, if the text should indeed be different, and can be applied directly to master branch.

@slivingston
Copy link
Member

I just noticed another commit involving more than documentation: 93b50b1. Your comment above applies here as well.

OK to include the change. I mention it here only as correction to my earlier comment where I describe 1f15678 as the only such commit.

@slivingston slivingston merged commit 99cc2e9 into python-control:master Dec 31, 2016
@slivingston
Copy link
Member

There are several instances of trailing whitespace, but they are small and only in documentation, so I decided to merge and avoid further delay.

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

Successfully merging this pull request may close these issues.

3 participants