Skip to content

Commit

Permalink
Merge pull request #543 from arthurkehrwald/clarify-param-type-hints
Browse files Browse the repository at this point in the history
Clarify BCP parameter type hints
  • Loading branch information
avanwinkle authored Nov 29, 2024
2 parents 4062d9a + b83ec6c commit 5669159
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/code/BCP_Protocol/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ While the BCP protocol was created as part of the MPF project, the intention is
* Parameters are in the format `name=value`
* Parameter names are case-insensitive
* Parameter values are case-sensitive
* Simple parameter values are prefixed with a string that indicates their data type: (`int:`, `float:`, `bool:`, `NoneType:`). For example, the integer 5 would appear in the command string as `int:5`.
* Simple parameter values of the following types are are prefixed with a string that indicates their data type: (`int:`, `float:`, `bool:`, `NoneType:`). For example, the integer 5 would appear in the command string as `int:5`.
* When a command includes one or more complex value types (list or dict) all parameters are encoded using JSON and the resulting encoded value is assigned to the `json:` parameter.
* Parameters are separated by an ampersand (`&`)
* Parameter names and their values are escaped using percent encoding as necessary; (details here).
Expand Down

0 comments on commit 5669159

Please sign in to comment.