Skip to content

Commit

Permalink
BG Issue 1342: Update docs to reflect possible hazard
Browse files Browse the repository at this point in the history
  • Loading branch information
catattack05 committed Aug 4, 2022
1 parent 451f3b3 commit 762a98e
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/plugins/python/_includes/choices.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -115,9 +115,11 @@ NOTE: Currently you must use a command from the same system (this restriction wi


==== Choice parameters
It's often useful to have the choices for one parameter depend on the current value of another. To do that you can use choice parameters.
It's often useful to have the choices for one parameter depend on the current value of another. To do that you can use choice parameters.

To create a reference on another parameter enclose its key in `${}`. How the parameter is passed depends on what choice source is being used.
To create a reference on another parameter enclose its key in `${}`. How the parameter is passed depends on what choice source is being used.

NOTE: When initializing the command creation page, BeerGarden will attempt to update all dependencies for choice parameters at once. If the dependent parameters are defined in such a way that causes side effects inside the command (for example, if A is a choice parameter that depends on B and C, but updating C changes an internal value A and B need), this could lead to unintended consequences or destructive behavior during command load.

For 'command' types the parameter will be passed as an argument to the command. For example, suppose you have two parameters: `day_type` and `day_of_week`. You'd like the choices for `day_of_week` to depend on what the user has selected for `day_type`:
[source,python]
Expand Down

0 comments on commit 762a98e

Please sign in to comment.