User/brianwei15/create first mode tutorial - #429
Merged
Conversation
yuzhiliu8
approved these changes
Sep 4, 2026
Comment on lines
+109
to
+116
| @register_mode( | ||
| id="uav.FlyToPointMode", | ||
| params_cls=FlyToPointParams, | ||
| targets=[UAV], | ||
| transition_labels=["complete"], | ||
| ) | ||
| class FlyToPointMode(Mode[UAV, FlyToPointParams]): | ||
| """Fly a UAV to one position in its local NED frame.""" |
Contributor
There was a problem hiding this comment.
It could be useful to use sphinx-directives that point to our python autoapi, which displays the docstrings within the actual method defintion. Can also apply to explanations of the API elsewhere
Not blocking for this PR tho
|
|
||
| .. code-block:: text | ||
|
|
||
| controls/sae_2025_ws/src/uav/uav/modes/FlyToPointMode.py |
Contributor
There was a problem hiding this comment.
vote to change the filename to fly_to_point_mode.py
I have an issue #335 to eventually rename mode files and going forward we should follow python filenaming standard
Comment on lines
1
to
5
| Creating Your First Mode | ||
| ======================== | ||
|
|
||
| .. rst-class:: lead | ||
|
|
Contributor
There was a problem hiding this comment.
Did you verify that this mode actually works?
Its fine to do this in a next PR, just make sure these docs get updated if the code needs to be changed.
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
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.
Issue(s) addressed:
Resolves #428, closes #384
Description:
Testing Done: