Skip to content

Commit

Permalink
Fix plural noun in doc (#498)
Browse files Browse the repository at this point in the history
  • Loading branch information
zliang-akamai authored Apr 19, 2024
1 parent 352efc8 commit 42e678d
Show file tree
Hide file tree
Showing 8 changed files with 19 additions and 19 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ Modules for retrieving and filtering on multiple Linode resources.

Name | Description |
--- | ------------ |
[linode.cloud.account_availability_list](./docs/modules/account_availability_list.md)|List and filter on Account Availabilitys.|
[linode.cloud.account_availability_list](./docs/modules/account_availability_list.md)|List and filter on Account Availabilities.|
[linode.cloud.database_engine_list](./docs/modules/database_engine_list.md)|List and filter on Managed Database engine types.|
[linode.cloud.database_list](./docs/modules/database_list.md)|List and filter on Linode Managed Databases.|
[linode.cloud.domain_list](./docs/modules/domain_list.md)|List and filter on Domains.|
Expand Down
12 changes: 6 additions & 6 deletions docs/modules/account_availability_list.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# account_availability_list

List and filter on Account Availabilitys.
List and filter on Account Availabilities.

**:warning: This module makes use of beta endpoints and requires the `api_version` field be explicitly set to `v4beta`.**

Expand All @@ -27,10 +27,10 @@ List and filter on Account Availabilitys.
| Field | Type | Required | Description |
|-----------|------|----------|------------------------------------------------------------------------------|
| `order` | <center>`str`</center> | <center>Optional</center> | The order to list Account Availabilitys in. **(Choices: `desc`, `asc`; Default: `asc`)** |
| `order_by` | <center>`str`</center> | <center>Optional</center> | The attribute to order Account Availabilitys by. |
| [`filters` (sub-options)](#filters) | <center>`list`</center> | <center>Optional</center> | A list of filters to apply to the resulting Account Availabilitys. |
| `count` | <center>`int`</center> | <center>Optional</center> | The number of Account Availabilitys to return. If undefined, all results will be returned. |
| `order` | <center>`str`</center> | <center>Optional</center> | The order to list Account Availabilities in. **(Choices: `desc`, `asc`; Default: `asc`)** |
| `order_by` | <center>`str`</center> | <center>Optional</center> | The attribute to order Account Availabilities by. |
| [`filters` (sub-options)](#filters) | <center>`list`</center> | <center>Optional</center> | A list of filters to apply to the resulting Account Availabilities. |
| `count` | <center>`int`</center> | <center>Optional</center> | The number of Account Availabilities to return. If undefined, all results will be returned. |

### filters

Expand All @@ -41,7 +41,7 @@ List and filter on Account Availabilitys.

## Return Values

- `account_availabilities` - The returned Account Availabilitys.
- `account_availabilities` - The returned Account Availabilities.

- Sample Response:
```json
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/vpc_subnet_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ List and filter on VPC Subnets.
| Field | Type | Required | Description |
|-----------|------|----------|------------------------------------------------------------------------------|
| `vpc_id` | <center>`int`</center> | <center>**Required**</center> | The parent VPC for this VPC Subnet. |
| `vpc_id` | <center>`int`</center> | <center>**Required**</center> | The parent VPC for the VPC Subnets. |
| `order` | <center>`str`</center> | <center>Optional</center> | The order to list VPC Subnets in. **(Choices: `desc`, `asc`; Default: `asc`)** |
| `order_by` | <center>`str`</center> | <center>Optional</center> | The attribute to order VPC Subnets by. |
| [`filters` (sub-options)](#filters) | <center>`list`</center> | <center>Optional</center> | A list of filters to apply to the resulting VPC Subnets. |
Expand Down
14 changes: 7 additions & 7 deletions plugins/module_utils/linode_common_list.py
Original file line number Diff line number Diff line change
Expand Up @@ -118,29 +118,29 @@ def spec(self):
"order": SpecField(
type=FieldType.string,
description=[
f"The order to list {self.result_display_name}s in."
f"The order to list {self.result_display_name} in."
],
default="asc",
choices=["desc", "asc"],
),
"order_by": SpecField(
type=FieldType.string,
description=[
f"The attribute to order {self.result_display_name}s by."
f"The attribute to order {self.result_display_name} by."
],
),
"filters": SpecField(
type=FieldType.list,
element_type=FieldType.dict,
suboptions=spec_filter,
description=[
f"A list of filters to apply to the resulting {self.result_display_name}s."
f"A list of filters to apply to the resulting {self.result_display_name}."
],
),
"count": SpecField(
type=FieldType.integer,
description=[
f"The number of {self.result_display_name}s to return.",
f"The number of {self.result_display_name} to return.",
"If undefined, all results will be returned.",
],
),
Expand All @@ -151,12 +151,12 @@ def spec(self):
options[param.name] = SpecField(
type=param.type,
description=[
f"The parent {param.display_name} for this {self.result_display_name}."
f"The parent {param.display_name} for the {self.result_display_name}."
],
required=True,
)

description = [f"List and filter on {self.result_display_name}s."]
description = [f"List and filter on {self.result_display_name}."]

if self.requires_beta:
description.append(BETA_DISCLAIMER)
Expand All @@ -169,7 +169,7 @@ def spec(self):
examples=self.examples,
return_values={
self.result_field_name: SpecReturnValue(
description=f"The returned {self.result_display_name}s.",
description=f"The returned {self.result_display_name}.",
docs_url=self.result_docs_url,
type=FieldType.list,
elements=FieldType.dict,
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/account_availability_list.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
)

module = ListModule(
result_display_name="Account Availability",
result_display_name="Account Availabilities",
result_field_name="account_availabilities",
endpoint_template="/account/availability",
result_docs_url="TBD",
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/image_list.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
)

module = ListModule(
result_display_name="Image",
result_display_name="Images",
result_field_name="images",
endpoint_template="/images",
result_docs_url="https://www.linode.com/docs/api/images/#images-list__responses",
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/vpc_list.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
)

module = ListModule(
result_display_name="VPC",
result_display_name="VPCs",
result_field_name="vpcs",
endpoint_template="/vpcs",
result_docs_url="",
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/vpc_subnet_list.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
from ansible_specdoc.objects import FieldType

module = ListModule(
result_display_name="VPC Subnet",
result_display_name="VPC Subnets",
result_field_name="subnets",
endpoint_template="/vpcs/{vpc_id}/subnets",
result_docs_url="",
Expand Down

0 comments on commit 42e678d

Please sign in to comment.