add docs on noteworthy difference from other languages #687
Conversation
This file contains 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 is an automated message.
|
Codecov Report
@@ Coverage Diff @@
## master #687 +/- ##
=======================================
Coverage 87.45% 87.45%
=======================================
Files 34 34
Lines 3579 3579
=======================================
Hits 3130 3130
Misses 449 449 Continue to review full report at Codecov.
|
imciner2
reviewed
May 30, 2022
| - Functions to calculate poles and zeros of systems are named using their plural forms, i.e., [`poles`](@ref) instead of `pole`, and [`tzeros`](@ref) instead of `tzero`. | ||
| - Simulation using [`lsim`](@ref), [`step`](@ref), [`impulse`](@ref) etc. computes arrays where time is in the second dimension rather than in the first dimension. Julia uses a *column major* memory layout, and this choice is made for performance reasons. | ||
| - Simulation using [`lsim`](@ref), [`step`](@ref), [`impulse`](@ref) etc. return a structure that can be plotted. These functions never plot anything themselves. | ||
| - Functions [`bode`](@ref), [`nyquist`](@ref) etc. do never produce a plot. Instead, see [`bodeplot`](@ref), [`nyquistplot`](@ref) etc. |
There was a problem hiding this comment.
The word "do" shouldn't be here - it should be "etc. never produce a plot".
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.