Remove reduntant @Values from parameter documentation #27082
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
peterbarker
changed the title
peterbarker
force-pushed
the
pr/loki077/pr_crash_detec_doc_fix
branch
from
3d47ff2 to
183cda6
Compare
amilcarlucas
suggested changes
May 17, 2024
Rover/Parameters.cpp
Outdated
| @@ -636,8 +635,7 @@ const AP_Param::GroupInfo ParametersG2::var_info[] = { | |||
| // @Param: FS_OPTIONS | |||
| // @DisplayName: Failsafe Options | |||
| // @Description: Bitmask to enable failsafe options | |||
| // @Values: 0:None,1:Failsafe enabled in Hold mode | |||
| // @Bitmask: 0:Failsafe enabled in Hold mode | |||
| // @Bitmask: 0:Failsafe enabled in Hold mode,1:Failsafe enabled in Hold mode | |||
There was a problem hiding this comment.
The same string twice. Something is wrong here.
| @@ -1135,8 +1132,7 @@ const AP_Param::GroupInfo ParametersG2::var_info[] = { | |||
| // @Param: DSPOILER_OPTS | |||
| // @DisplayName: Differential spoiler and crow flaps options | |||
| // @Description: Differential spoiler and crow flaps options | |||
| // @Values: 0: none, 1: D spoilers have pitch input, 2: use both control surfaces on each wing for roll, 4: Progressive crow flaps only first (0-50% flap in) then crow flaps (50 - 100% flap in) | |||
There was a problem hiding this comment.
Some of the details should be added in the description IMHO
As this was causing a CI check we made locally to compare param values to param_metadata generated xml file.
…braries we have enforced this one-of-Values-or-Bitmask in libraries for a long time, and should have been enforcing it in vehicles before now. MissionPlanner and MAVProxy ignore Values if Bitmask is present
peterbarker
force-pushed
the
pr/loki077/pr_crash_detec_doc_fix
branch
from
183cda6 to
c6ff1b1
Compare
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.
we have enforced this one-of-Values-or-Bitmask in libraries for a long time, and should have been enforcing it in vehicles before now.
MissionPlanner and MAVProxy ignore Values if Bitmask is present
Built on top of #27070