diff --git a/docs/inventory/instance.rst b/docs/inventory/instance.rst index 18445b50..c4f28a31 100644 --- a/docs/inventory/instance.rst +++ b/docs/inventory/instance.rst @@ -76,19 +76,19 @@ Parameters **parent_group (type=str):** - \• parent group for keyed group + \• parent group for keyed group. **prefix (type=str):** - \• A keyed group name will start with this prefix + \• A keyed group name will start with this prefix. **separator (type=str, default=_):** - \• separator used to build the keyed group name + \• separator used to build the keyed group name. **key (type=str):** - \• The key from input dictionary used to generate groups + \• The key from input dictionary used to generate groups. **default_value (type=str):** @@ -98,7 +98,7 @@ Parameters **trailing_separator (type=bool, default=True):** - \• Set this option to :literal:`False` to omit the :literal:`keyed\_groups[].separator` after the host variable when the value is an empty string. + \• Set this option to :literal:`false` to omit the :literal:`keyed\_groups[].separator` after the host variable when the value is an empty string. \• This option is mutually exclusive with :literal:`keyed\_groups[].default\_value`. @@ -109,13 +109,13 @@ Parameters **leading_separator (type=boolean, default=True):** - \• Use in conjunction with keyed\_groups. + \• Use in conjunction with :literal:`keyed\_groups`. \• By default, a keyed group that does not have a prefix or a separator provided will have a name that starts with an underscore. - \• This is because the default prefix is "" and the default separator is "\_". + \• This is because the default prefix is :literal:`""` and the default separator is :literal:`"\_"`. - \• Set this option to False to omit the leading underscore (or other separator) if no prefix is given. + \• Set this option to :literal:`false` to omit the leading underscore (or other separator) if no prefix is given. \• If the group name is derived from a mapping the separator is still used to concatenate the items. diff --git a/docs/modules/image.md b/docs/modules/image.md index 9b13dc08..d16b3835 100644 --- a/docs/modules/image.md +++ b/docs/modules/image.md @@ -73,7 +73,7 @@ Manage a Linode Image. | `wait` |
`bool`
|
Optional
| Wait for the image to have status `available` before returning. **(Default: `True`)** | | `wait_timeout` |
`int`
|
Optional
| The amount of time, in seconds, to wait for an image to have status `available`. **(Default: `600`)** | | `tags` |
`list`
|
Optional
| A list of customized tags of this new Image. **(Updatable)** | -| `replica_regions` |
`list`
|
Optional
| A list of regions that customer wants to replicate this image in. At least one available region must be provided and only core regions allowed. Existing images in the regions not passed will be removed. NOTE: Image replication may not currently be available to all users. **(Updatable)** | +| `replica_regions` |
`list`
|
Optional
| A list of regions that customer wants to replicate this image in. At least one available region must be provided and only core regions allowed. Existing images in the regions not passed will be removed. **(Updatable)** | | `wait_for_replications` |
`bool`
|
Optional
| Wait for the all the replications `available` before returning. **(Default: `False`)** | ## Return Values diff --git a/plugins/modules/image.py b/plugins/modules/image.py index 7a34c7c5..147cd251 100644 --- a/plugins/modules/image.py +++ b/plugins/modules/image.py @@ -103,8 +103,7 @@ description=[ "A list of regions that customer wants to replicate this image in. " "At least one available region must be provided and only core regions allowed. " - "Existing images in the regions not passed will be removed. " - "NOTE: Image replication may not currently be available to all users.", + "Existing images in the regions not passed will be removed. ", ], ), "wait_for_replications": SpecField(