Fix documentation and math display errors #448
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
This fixes the following errors, which made the last two bullets display incorrectly. python-control/doc/conventions.rst:229: WARNING: Bullet list ends without a blank line; unexpected unindent. python-control/doc/conventions.rst:232: WARNING: Bullet list ends without a blank line; unexpected unindent.
This also fixes the following warnings: python-control/control/statefbk.py:docstring of control.lqe:6: WARNING: Unexpected indentation. python-control/control/statefbk.py:docstring of control.lqe:36: WARNING: Unexpected indentation.
bnavigator
requested changes
Aug 14, 2020
Contributor
bnavigator
left a comment
bnavigator
left a comment
There was a problem hiding this comment.
LGTM, except the scipy reference
control/timeresp.py
Outdated
| ----- | ||
| For discrete time systems, the input/output response is computed using the | ||
| :scipy-signal:ref:`scipy.signal.dlsim` function. | ||
| scipy.signal.dlsim function. |
Contributor
There was a problem hiding this comment.
Contributor
Author
There was a problem hiding this comment.
Thanks! I've updated the commits to fix it.
Contributor
I think your "fixed" screenshot shows the wrong output portion. |
The link to dlsim was broken, producing a warning. The links to lsim were missing.
This left-over example configuration caused the intended intersphinx_mapping not to work, thus breaking links to scipy and numpy. Now the links should work again.
laurensvalk
force-pushed
the
docwarnings
branch
from
2aee9ed to
69c33e5
Compare
Contributor
Author
|
Thanks for the review. I've adapted it based on your feedback and fixed the screenshot above. |
bnavigator
approved these changes
Aug 14, 2020
Contributor
|
I submitted a PR into your branch to take this even further: pybricks#1 |
Contributor
Author
|
Sounds good - I just merged those into this PR. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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 changes
to:
This changes:
to
Inverse has now been changed to
^{-1}as well.This changes:
to:
and a few other minor fixes.