Add reserved/default param info #168
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
en/guide/xml_schema.md
Outdated
| - `label` - Display name to represent the parameter in a GCS or other UI | ||
| - `units` - SI units for the value. | ||
| - `enum` - Enum containing possible values for the parameter (if applicable). | ||
| - `decimalPlaces` - Hint to a UI about how many decimal places to use if the parameter value is displayed. | ||
| - `increment` - Allowed increments for the parameter value. | ||
| - `minValue` - Minimum value for param. | ||
| - `maxValue` - Maximum value for the param. | ||
|
|
||
|
|
||
| - `reserved` - Param is reserved for future use. Default is `False`. |
There was a problem hiding this comment.
I had to stare at this for a bit to stop being confused. Specifically the Default is `False`. part. I was thinking that was talking about the default value for the param itself. Not sure if that's just me.
There was a problem hiding this comment.
If you can find it confusing, then someone else will too. Reworded:
Boolean indicating whether param is reserved for future use. If the attributes is not declared, then implicitly `reserved="False".
|
@DonLakeFlyer I am assuming that otherwise you are happy with this and therefore merging. If that is not true, let me know! |
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.
The reserved and default attributes for params went into the schema this week. This PR documents the intent.
Note that the change is in and can be used, but I hope for ArduPilot/pymavlink#269 to go in to make sure that generated source code docs reflect this.
FYI @amilcarlucas