Skip to content
This repository was archived by the owner on Jan 13, 2025. It is now read-only.

docs: Fix formatting of request arg in docstring #211

Merged
merged 2 commits into from
Mar 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 6 additions & 12 deletions google/cloud/orgpolicy_v2/services/org_policy/async_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -273,8 +273,7 @@ async def sample_list_constraints():

Args:
request (Optional[Union[google.cloud.orgpolicy_v2.types.ListConstraintsRequest, dict]]):
The request object. The request sent to the
[ListConstraints]
The request object. The request sent to the [ListConstraints]
[google.cloud.orgpolicy.v2.OrgPolicy.ListConstraints]
method.
parent (:class:`str`):
Expand Down Expand Up @@ -407,8 +406,7 @@ async def sample_list_policies():

Args:
request (Optional[Union[google.cloud.orgpolicy_v2.types.ListPoliciesRequest, dict]]):
The request object. The request sent to the
[ListPolicies]
The request object. The request sent to the [ListPolicies]
[google.cloud.orgpolicy.v2.OrgPolicy.ListPolicies]
method.
parent (:class:`str`):
Expand Down Expand Up @@ -662,8 +660,7 @@ async def sample_get_effective_policy():

Args:
request (Optional[Union[google.cloud.orgpolicy_v2.types.GetEffectivePolicyRequest, dict]]):
The request object. The request sent to the
[GetEffectivePolicy]
The request object. The request sent to the [GetEffectivePolicy]
[google.cloud.orgpolicy.v2.OrgPolicy.GetEffectivePolicy]
method.
name (:class:`str`):
Expand Down Expand Up @@ -783,8 +780,7 @@ async def sample_create_policy():

Args:
request (Optional[Union[google.cloud.orgpolicy_v2.types.CreatePolicyRequest, dict]]):
The request object. The request sent to the
[CreatePolicyRequest]
The request object. The request sent to the [CreatePolicyRequest]
[google.cloud.orgpolicy.v2.OrgPolicy.CreatePolicy]
method.
parent (:class:`str`):
Expand Down Expand Up @@ -917,8 +913,7 @@ async def sample_update_policy():

Args:
request (Optional[Union[google.cloud.orgpolicy_v2.types.UpdatePolicyRequest, dict]]):
The request object. The request sent to the
[UpdatePolicyRequest]
The request object. The request sent to the [UpdatePolicyRequest]
[google.cloud.orgpolicy.v2.OrgPolicy.UpdatePolicy]
method.
policy (:class:`google.cloud.orgpolicy_v2.types.Policy`):
Expand Down Expand Up @@ -1032,8 +1027,7 @@ async def sample_delete_policy():

Args:
request (Optional[Union[google.cloud.orgpolicy_v2.types.DeletePolicyRequest, dict]]):
The request object. The request sent to the
[DeletePolicy]
The request object. The request sent to the [DeletePolicy]
[google.cloud.orgpolicy.v2.OrgPolicy.DeletePolicy]
method.
name (:class:`str`):
Expand Down
18 changes: 6 additions & 12 deletions google/cloud/orgpolicy_v2/services/org_policy/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -518,8 +518,7 @@ def sample_list_constraints():

Args:
request (Union[google.cloud.orgpolicy_v2.types.ListConstraintsRequest, dict]):
The request object. The request sent to the
[ListConstraints]
The request object. The request sent to the [ListConstraints]
[google.cloud.orgpolicy.v2.OrgPolicy.ListConstraints]
method.
parent (str):
Expand Down Expand Up @@ -642,8 +641,7 @@ def sample_list_policies():

Args:
request (Union[google.cloud.orgpolicy_v2.types.ListPoliciesRequest, dict]):
The request object. The request sent to the
[ListPolicies]
The request object. The request sent to the [ListPolicies]
[google.cloud.orgpolicy.v2.OrgPolicy.ListPolicies]
method.
parent (str):
Expand Down Expand Up @@ -877,8 +875,7 @@ def sample_get_effective_policy():

Args:
request (Union[google.cloud.orgpolicy_v2.types.GetEffectivePolicyRequest, dict]):
The request object. The request sent to the
[GetEffectivePolicy]
The request object. The request sent to the [GetEffectivePolicy]
[google.cloud.orgpolicy.v2.OrgPolicy.GetEffectivePolicy]
method.
name (str):
Expand Down Expand Up @@ -988,8 +985,7 @@ def sample_create_policy():

Args:
request (Union[google.cloud.orgpolicy_v2.types.CreatePolicyRequest, dict]):
The request object. The request sent to the
[CreatePolicyRequest]
The request object. The request sent to the [CreatePolicyRequest]
[google.cloud.orgpolicy.v2.OrgPolicy.CreatePolicy]
method.
parent (str):
Expand Down Expand Up @@ -1112,8 +1108,7 @@ def sample_update_policy():

Args:
request (Union[google.cloud.orgpolicy_v2.types.UpdatePolicyRequest, dict]):
The request object. The request sent to the
[UpdatePolicyRequest]
The request object. The request sent to the [UpdatePolicyRequest]
[google.cloud.orgpolicy.v2.OrgPolicy.UpdatePolicy]
method.
policy (google.cloud.orgpolicy_v2.types.Policy):
Expand Down Expand Up @@ -1217,8 +1212,7 @@ def sample_delete_policy():

Args:
request (Union[google.cloud.orgpolicy_v2.types.DeletePolicyRequest, dict]):
The request object. The request sent to the
[DeletePolicy]
The request object. The request sent to the [DeletePolicy]
[google.cloud.orgpolicy.v2.OrgPolicy.DeletePolicy]
method.
name (str):
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -412,7 +412,6 @@ def __call__(
The request object. The request sent to the [CreatePolicyRequest]
[google.cloud.orgpolicy.v2.OrgPolicy.CreatePolicy]
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 @@ -523,7 +522,6 @@ def __call__(
The request object. The request sent to the [DeletePolicy]
[google.cloud.orgpolicy.v2.OrgPolicy.DeletePolicy]
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 @@ -608,7 +606,6 @@ def __call__(
The request object. The request sent to the [GetEffectivePolicy]
[google.cloud.orgpolicy.v2.OrgPolicy.GetEffectivePolicy]
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 @@ -709,7 +706,6 @@ def __call__(
request (~.orgpolicy.GetPolicyRequest):
The request object. The request sent to the [GetPolicy]
[google.cloud.orgpolicy.v2.OrgPolicy.GetPolicy] 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 @@ -809,7 +805,6 @@ def __call__(
The request object. The request sent to the [ListConstraints]
[google.cloud.orgpolicy.v2.OrgPolicy.ListConstraints]
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 @@ -911,7 +906,6 @@ def __call__(
The request object. The request sent to the [ListPolicies]
[google.cloud.orgpolicy.v2.OrgPolicy.ListPolicies]
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 @@ -1012,7 +1006,6 @@ def __call__(
The request object. The request sent to the [UpdatePolicyRequest]
[google.cloud.orgpolicy.v2.OrgPolicy.UpdatePolicy]
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