Skip to content
This repository was archived by the owner on Sep 5, 2023. It is now read-only.

docs: Fix formatting of request arg in docstring #266

Merged
parthea merged 2 commits into from
Mar 23, 2023
Merged

docs: Fix formatting of request arg in docstring #266

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a8e6f24
docs: Fix formatting of request arg in docstring
gcf-owl-bot[bot] Mar 22, 2023
37c10cb
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Mar 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 6 additions & 9 deletions google/cloud/resourcemanager_v3/services/folders/async_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -816,10 +816,10 @@ async def sample_update_folder():
[UpdateFolder][google.cloud.resourcemanager.v3.Folder.UpdateFolder]
method.

Only the `display_name` field can be changed. All other
fields will be ignored. Use the
Only the ``display_name`` field can be changed. All
other fields will be ignored. Use the
[MoveFolder][google.cloud.resourcemanager.v3.Folders.MoveFolder]
method to change the `parent` field.
method to change the ``parent`` field.
folder (:class:`google.cloud.resourcemanager_v3.types.Folder`):
Required. The new definition of the Folder. It must
include the ``name`` field, which cannot be changed.
Expand Down Expand Up @@ -1345,8 +1345,7 @@ async def sample_get_iam_policy():

Args:
request (Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]]):
The request object. Request message for `GetIamPolicy`
method.
The request object. Request message for ``GetIamPolicy`` method.
resource (:class:`str`):
REQUIRED: The resource for which the
policy is being requested. See the
Expand Down Expand Up @@ -1524,8 +1523,7 @@ async def sample_set_iam_policy():

Args:
request (Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]]):
The request object. Request message for `SetIamPolicy`
method.
The request object. Request message for ``SetIamPolicy`` method.
resource (:class:`str`):
REQUIRED: The resource for which the
policy is being specified. See the
Expand Down Expand Up @@ -1696,8 +1694,7 @@ async def sample_test_iam_permissions():

Args:
request (Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]]):
The request object. Request message for
`TestIamPermissions` method.
The request object. Request message for ``TestIamPermissions`` method.
resource (:class:`str`):
REQUIRED: The resource for which the
policy detail is being requested. See
Expand Down
15 changes: 6 additions & 9 deletions google/cloud/resourcemanager_v3/services/folders/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1026,10 +1026,10 @@ def sample_update_folder():
[UpdateFolder][google.cloud.resourcemanager.v3.Folder.UpdateFolder]
method.

Only the `display_name` field can be changed. All other
fields will be ignored. Use the
Only the ``display_name`` field can be changed. All
other fields will be ignored. Use the
[MoveFolder][google.cloud.resourcemanager.v3.Folders.MoveFolder]
method to change the `parent` field.
method to change the ``parent`` field.
folder (google.cloud.resourcemanager_v3.types.Folder):
Required. The new definition of the Folder. It must
include the ``name`` field, which cannot be changed.
Expand Down Expand Up @@ -1555,8 +1555,7 @@ def sample_get_iam_policy():

Args:
request (Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]):
The request object. Request message for `GetIamPolicy`
method.
The request object. Request message for ``GetIamPolicy`` method.
resource (str):
REQUIRED: The resource for which the
policy is being requested. See the
Expand Down Expand Up @@ -1722,8 +1721,7 @@ def sample_set_iam_policy():

Args:
request (Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]):
The request object. Request message for `SetIamPolicy`
method.
The request object. Request message for ``SetIamPolicy`` method.
resource (str):
REQUIRED: The resource for which the
policy is being specified. See the
Expand Down Expand Up @@ -1891,8 +1889,7 @@ def sample_test_iam_permissions():

Args:
request (Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]):
The request object. Request message for
`TestIamPermissions` method.
The request object. Request message for ``TestIamPermissions`` method.
resource (str):
REQUIRED: The resource for which the
policy detail is being requested. See
Expand Down
2 changes: 0 additions & 2 deletions google/cloud/resourcemanager_v3/services/folders/transports/rest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1179,7 +1179,6 @@ def __call__(
request (~.folders.SearchFoldersRequest):
The request object. The request message for searching
folders.

retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1639,7 +1638,6 @@ def __call__(
other fields will be ignored. Use the
[MoveFolder][google.cloud.resourcemanager.v3.Folders.MoveFolder]
method to change the ``parent`` field.

retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down
18 changes: 7 additions & 11 deletions google/cloud/resourcemanager_v3/services/organizations/async_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,9 +258,9 @@ async def sample_get_organization():

Args:
request (Optional[Union[google.cloud.resourcemanager_v3.types.GetOrganizationRequest, dict]]):
The request object. The request sent to the
`GetOrganization` method. The `name` field is required.
`organization_id` is no longer accepted.
The request object. The request sent to the ``GetOrganization`` method. The
``name`` field is required. ``organization_id`` is no
longer accepted.
name (:class:`str`):
Required. The resource name of the Organization to
fetch. This is the organization's relative path in the
Expand Down Expand Up @@ -381,8 +381,7 @@ async def sample_search_organizations():

Args:
request (Optional[Union[google.cloud.resourcemanager_v3.types.SearchOrganizationsRequest, dict]]):
The request object. The request sent to the
`SearchOrganizations` method.
The request object. The request sent to the ``SearchOrganizations`` method.
query (:class:`str`):
Optional. An optional query string used to filter the
Organizations to return in the response. Query rules are
Expand Down Expand Up @@ -517,8 +516,7 @@ async def sample_get_iam_policy():

Args:
request (Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]]):
The request object. Request message for `GetIamPolicy`
method.
The request object. Request message for ``GetIamPolicy`` method.
resource (:class:`str`):
REQUIRED: The resource for which the
policy is being requested. See the
Expand Down Expand Up @@ -699,8 +697,7 @@ async def sample_set_iam_policy():

Args:
request (Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]]):
The request object. Request message for `SetIamPolicy`
method.
The request object. Request message for ``SetIamPolicy`` method.
resource (:class:`str`):
REQUIRED: The resource for which the
policy is being specified. See the
Expand Down Expand Up @@ -871,8 +868,7 @@ async def sample_test_iam_permissions():

Args:
request (Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]]):
The request object. Request message for
`TestIamPermissions` method.
The request object. Request message for ``TestIamPermissions`` method.
resource (:class:`str`):
REQUIRED: The resource for which the
policy detail is being requested. See
Expand Down
18 changes: 7 additions & 11 deletions google/cloud/resourcemanager_v3/services/organizations/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -478,9 +478,9 @@ def sample_get_organization():

Args:
request (Union[google.cloud.resourcemanager_v3.types.GetOrganizationRequest, dict]):
The request object. The request sent to the
`GetOrganization` method. The `name` field is required.
`organization_id` is no longer accepted.
The request object. The request sent to the ``GetOrganization`` method. The
``name`` field is required. ``organization_id`` is no
longer accepted.
name (str):
Required. The resource name of the Organization to
fetch. This is the organization's relative path in the
Expand Down Expand Up @@ -592,8 +592,7 @@ def sample_search_organizations():

Args:
request (Union[google.cloud.resourcemanager_v3.types.SearchOrganizationsRequest, dict]):
The request object. The request sent to the
`SearchOrganizations` method.
The request object. The request sent to the ``SearchOrganizations`` method.
query (str):
Optional. An optional query string used to filter the
Organizations to return in the response. Query rules are
Expand Down Expand Up @@ -728,8 +727,7 @@ def sample_get_iam_policy():

Args:
request (Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]):
The request object. Request message for `GetIamPolicy`
method.
The request object. Request message for ``GetIamPolicy`` method.
resource (str):
REQUIRED: The resource for which the
policy is being requested. See the
Expand Down Expand Up @@ -898,8 +896,7 @@ def sample_set_iam_policy():

Args:
request (Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]):
The request object. Request message for `SetIamPolicy`
method.
The request object. Request message for ``SetIamPolicy`` method.
resource (str):
REQUIRED: The resource for which the
policy is being specified. See the
Expand Down Expand Up @@ -1067,8 +1064,7 @@ def sample_test_iam_permissions():

Args:
request (Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]):
The request object. Request message for
`TestIamPermissions` method.
The request object. Request message for ``TestIamPermissions`` method.
resource (str):
REQUIRED: The resource for which the
policy detail is being requested. See
Expand Down
1 change: 0 additions & 1 deletion google/cloud/resourcemanager_v3/services/organizations/transports/rest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -519,7 +519,6 @@ def __call__(
The request object. The request sent to the ``GetOrganization`` method. The
``name`` field is required. ``organization_id`` is no
longer accepted.

retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down
16 changes: 6 additions & 10 deletions google/cloud/resourcemanager_v3/services/projects/async_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -809,10 +809,10 @@ async def sample_update_project():
[UpdateProject][google.cloud.resourcemanager.v3.Projects.UpdateProject]
method.

Only the `display_name` and `labels` fields can be
Only the ``display_name`` and ``labels`` fields can be
change. Use the
[MoveProject][google.cloud.resourcemanager.v3.Projects.MoveProject]
method to change the `parent` field.
method to change the ``parent`` field.
project (:class:`google.cloud.resourcemanager_v3.types.Project`):
Required. The new definition of the
project.
Expand Down Expand Up @@ -1237,8 +1237,7 @@ async def sample_undelete_project():

Args:
request (Optional[Union[google.cloud.resourcemanager_v3.types.UndeleteProjectRequest, dict]]):
The request object. The request sent to the
[UndeleteProject]
The request object. The request sent to the [UndeleteProject]
[google.cloud.resourcemanager.v3.Projects.UndeleteProject]
method.
name (:class:`str`):
Expand Down Expand Up @@ -1357,8 +1356,7 @@ async def sample_get_iam_policy():

Args:
request (Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]]):
The request object. Request message for `GetIamPolicy`
method.
The request object. Request message for ``GetIamPolicy`` method.
resource (:class:`str`):
REQUIRED: The resource for which the
policy is being requested. See the
Expand Down Expand Up @@ -1583,8 +1581,7 @@ async def sample_set_iam_policy():

Args:
request (Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]]):
The request object. Request message for `SetIamPolicy`
method.
The request object. Request message for ``SetIamPolicy`` method.
resource (:class:`str`):
REQUIRED: The resource for which the
policy is being specified. See the
Expand Down Expand Up @@ -1752,8 +1749,7 @@ async def sample_test_iam_permissions():

Args:
request (Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]]):
The request object. Request message for
`TestIamPermissions` method.
The request object. Request message for ``TestIamPermissions`` method.
resource (:class:`str`):
REQUIRED: The resource for which the
policy detail is being requested. See
Expand Down
16 changes: 6 additions & 10 deletions google/cloud/resourcemanager_v3/services/projects/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1019,10 +1019,10 @@ def sample_update_project():
[UpdateProject][google.cloud.resourcemanager.v3.Projects.UpdateProject]
method.

Only the `display_name` and `labels` fields can be
Only the ``display_name`` and ``labels`` fields can be
change. Use the
[MoveProject][google.cloud.resourcemanager.v3.Projects.MoveProject]
method to change the `parent` field.
method to change the ``parent`` field.
project (google.cloud.resourcemanager_v3.types.Project):
Required. The new definition of the
project.
Expand Down Expand Up @@ -1447,8 +1447,7 @@ def sample_undelete_project():

Args:
request (Union[google.cloud.resourcemanager_v3.types.UndeleteProjectRequest, dict]):
The request object. The request sent to the
[UndeleteProject]
The request object. The request sent to the [UndeleteProject]
[google.cloud.resourcemanager.v3.Projects.UndeleteProject]
method.
name (str):
Expand Down Expand Up @@ -1567,8 +1566,7 @@ def sample_get_iam_policy():

Args:
request (Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]):
The request object. Request message for `GetIamPolicy`
method.
The request object. Request message for ``GetIamPolicy`` method.
resource (str):
REQUIRED: The resource for which the
policy is being requested. See the
Expand Down Expand Up @@ -1781,8 +1779,7 @@ def sample_set_iam_policy():

Args:
request (Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]):
The request object. Request message for `SetIamPolicy`
method.
The request object. Request message for ``SetIamPolicy`` method.
resource (str):
REQUIRED: The resource for which the
policy is being specified. See the
Expand Down Expand Up @@ -1947,8 +1944,7 @@ def sample_test_iam_permissions():

Args:
request (Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]):
The request object. Request message for
`TestIamPermissions` method.
The request object. Request message for ``TestIamPermissions`` method.
resource (str):
REQUIRED: The resource for which the
policy detail is being requested. See
Expand Down
8 changes: 0 additions & 8 deletions google/cloud/resourcemanager_v3/services/projects/transports/rest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -569,7 +569,6 @@ def __call__(
The request object. The request sent to the
[CreateProject][google.cloud.resourcemanager.v3.Projects.CreateProject]
method.

retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -667,7 +666,6 @@ def __call__(
request (~.projects.DeleteProjectRequest):
The request object. [DeleteProject][google.cloud.resourcemanager.v3.Projects.DeleteProject]
method.

retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -927,7 +925,6 @@ def __call__(
The request object. The request sent to the
[GetProject][google.cloud.resourcemanager.v3.Projects.GetProject]
method.

retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1022,7 +1019,6 @@ def __call__(
The request object. The request sent to the
[ListProjects][google.cloud.resourcemanager.v3.Projects.ListProjects]
method.

retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1122,7 +1118,6 @@ def __call__(
The request object. The request sent to
[MoveProject][google.cloud.resourcemanager.v3.Projects.MoveProject]
method.

retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1211,7 +1206,6 @@ def __call__(
The request object. The request sent to the
[SearchProjects][google.cloud.resourcemanager.v3.Projects.SearchProjects]
method.

retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1573,7 +1567,6 @@ def __call__(
The request object. The request sent to the [UndeleteProject]
[google.cloud.resourcemanager.v3.Projects.UndeleteProject]
method.

retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1679,7 +1672,6 @@ def __call__(
change. Use the
[MoveProject][google.cloud.resourcemanager.v3.Projects.MoveProject]
method to change the ``parent`` field.

retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down
Loading