Improve documentation for motor failure injection and detection #25756
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
Reading it again I decided adding the sentance in 4d2170c is not clear enough.
The functionality is in my eyes pretty basic but so far completely undocumented so I went through the code and added a paragraph based on questions I received.
hamishwillee
previously approved these changes
Oct 14, 2025
There was a problem hiding this comment.
@MaEtUgR This is excellent. I subedited it slightly to my taste and ran prettier.
|
No flaws found |
hamishwillee
approved these changes
Oct 15, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Solved Problem
When answering questions about motor failure injection and motor failure detection, I found that there is next to no documentation. Even though I plan to change the implementation at some point it's worth documenting the current state.
Tagging @potaito to make sure the author gets to know about it.
Solution
Add a full example to stop a single motor to make things very clear:
Add a paragraph for failure detector covering motor failures:
Changelog Entry