Improve documentation of pidloop:reset. #2819
Merged
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
Add note that the `RESET` method also resets the derivative term, in addition to the integral term. See https://github.com/KSP-KOS/KOS/blob/0a05d71902284669261b9aa0cfb9493ec8a6650b/src/kOS.Safe/Encapsulation/PIDLoop.cs#L263
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.
Add note that the
RESETmethod also resets the derivative term, inaddition to the integral term. See
KOS/src/kOS.Safe/Encapsulation/PIDLoop.cs
Line 263 in 0a05d71
NOTE: Please be sure to test this before you merge the PR. I had some trouble installing Sphinx and was consequently unable to test it myself.