docs: Fix formatting of request arg in docstring (#232)

* docs: Fix formatting of request arg in docstring chore: Update gapic-generator-python to v1.9.1 PiperOrigin-RevId: 518604533 Source-Link: googleapis/googleapis@8a085ae Source-Link: googleapis/googleapis-gen@b2ab4b0 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiYjJhYjRiMGEwYWUyOTA3ZTgxMmMyMDkxOThhNzRlMDg5OGFmY2IwNCJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
googleapis · Mar 23, 2023 · c08dfd7 · c08dfd7
1 parent fc2b7ea
commit c08dfd7
Show file tree

Hide file tree

Showing 6 changed files with 46 additions and 74 deletions.
diff --git a/packages/google-cloud-gke-hub/google/cloud/gkehub_v1/services/gke_hub/async_client.py b/packages/google-cloud-gke-hub/google/cloud/gkehub_v1/services/gke_hub/async_client.py
@@ -266,8 +266,7 @@ async def sample_list_memberships():
 
  Args:
  request (Optional[Union[google.cloud.gkehub_v1.types.ListMembershipsRequest, dict]]):
- The request object. Request message for
- `GkeHub.ListMemberships` method.
+ The request object. Request message for ``GkeHub.ListMemberships`` method.
  parent (:class:`str`):
  Required. The parent (project and location) where the
  Memberships will be listed. Specified in the format
@@ -380,8 +379,7 @@ async def sample_list_features():
 
  Args:
  request (Optional[Union[google.cloud.gkehub_v1.types.ListFeaturesRequest, dict]]):
- The request object. Request message for
- `GkeHub.ListFeatures` method.
+ The request object. Request message for ``GkeHub.ListFeatures`` method.
  parent (:class:`str`):
  Required. The parent (project and location) where the
  Features will be listed. Specified in the format
@@ -494,8 +492,7 @@ async def sample_get_membership():
 
  Args:
  request (Optional[Union[google.cloud.gkehub_v1.types.GetMembershipRequest, dict]]):
- The request object. Request message for
- `GkeHub.GetMembership` method.
+ The request object. Request message for ``GkeHub.GetMembership`` method.
  name (:class:`str`):
  Required. The Membership resource name in the format
  ``projects/*/locations/*/memberships/*``.
@@ -595,8 +592,7 @@ async def sample_get_feature():
 
  Args:
  request (Optional[Union[google.cloud.gkehub_v1.types.GetFeatureRequest, dict]]):
- The request object. Request message for
- `GkeHub.GetFeature` method.
+ The request object. Request message for ``GkeHub.GetFeature`` method.
  name (:class:`str`):
  Required. The Feature resource name in the format
  ``projects/*/locations/*/features/*``
@@ -708,8 +704,8 @@ async def sample_create_membership():
 
  Args:
  request (Optional[Union[google.cloud.gkehub_v1.types.CreateMembershipRequest, dict]]):
- The request object. Request message for the
- `GkeHub.CreateMembership` method.
+ The request object. Request message for the ``GkeHub.CreateMembership``
+ method.
  parent (:class:`str`):
  Required. The parent (project and location) where the
  Memberships will be created. Specified in the format
@@ -853,8 +849,7 @@ async def sample_create_feature():
 
  Args:
  request (Optional[Union[google.cloud.gkehub_v1.types.CreateFeatureRequest, dict]]):
- The request object. Request message for the
- `GkeHub.CreateFeature` method.
+ The request object. Request message for the ``GkeHub.CreateFeature`` method.
  parent (:class:`str`):
  Required. The parent (project and location) where the
  Feature will be created. Specified in the format
@@ -990,8 +985,7 @@ async def sample_delete_membership():
 
  Args:
  request (Optional[Union[google.cloud.gkehub_v1.types.DeleteMembershipRequest, dict]]):
- The request object. Request message for
- `GkeHub.DeleteMembership` method.
+ The request object. Request message for ``GkeHub.DeleteMembership`` method.
  name (:class:`str`):
  Required. The Membership resource name in the format
  ``projects/*/locations/*/memberships/*``.
@@ -1113,8 +1107,7 @@ async def sample_delete_feature():
 
  Args:
  request (Optional[Union[google.cloud.gkehub_v1.types.DeleteFeatureRequest, dict]]):
- The request object. Request message for
- `GkeHub.DeleteFeature` method.
+ The request object. Request message for ``GkeHub.DeleteFeature`` method.
  name (:class:`str`):
  Required. The Feature resource name in the format
  ``projects/*/locations/*/features/*``.
@@ -1239,8 +1232,7 @@ async def sample_update_membership():
 
  Args:
  request (Optional[Union[google.cloud.gkehub_v1.types.UpdateMembershipRequest, dict]]):
- The request object. Request message for
- `GkeHub.UpdateMembership` method.
+ The request object. Request message for ``GkeHub.UpdateMembership`` method.
  name (:class:`str`):
  Required. The Membership resource name in the format
  ``projects/*/locations/*/memberships/*``.
@@ -1380,8 +1372,7 @@ async def sample_update_feature():
 
  Args:
  request (Optional[Union[google.cloud.gkehub_v1.types.UpdateFeatureRequest, dict]]):
- The request object. Request message for
- `GkeHub.UpdateFeature` method.
+ The request object. Request message for ``GkeHub.UpdateFeature`` method.
  name (:class:`str`):
  Required. The Feature resource name in the format
  ``projects/*/locations/*/features/*``.
@@ -1518,9 +1509,8 @@ async def sample_generate_connect_manifest():
 
  Args:
  request (Optional[Union[google.cloud.gkehub_v1.types.GenerateConnectManifestRequest, dict]]):
- The request object. Request message for
- `GkeHub.GenerateConnectManifest` method.
- .
+ The request object. Request message for ``GkeHub.GenerateConnectManifest``
+ method. .
  retry (google.api_core.retry.Retry): Designation of what errors, if any,
  should be retried.
  timeout (float): The timeout for this request.

diff --git a/packages/google-cloud-gke-hub/google/cloud/gkehub_v1/services/gke_hub/client.py b/packages/google-cloud-gke-hub/google/cloud/gkehub_v1/services/gke_hub/client.py
@@ -525,8 +525,7 @@ def sample_list_memberships():
 
  Args:
  request (Union[google.cloud.gkehub_v1.types.ListMembershipsRequest, dict]):
- The request object. Request message for
- `GkeHub.ListMemberships` method.
+ The request object. Request message for ``GkeHub.ListMemberships`` method.
  parent (str):
  Required. The parent (project and location) where the
  Memberships will be listed. Specified in the format
@@ -639,8 +638,7 @@ def sample_list_features():
 
  Args:
  request (Union[google.cloud.gkehub_v1.types.ListFeaturesRequest, dict]):
- The request object. Request message for
- `GkeHub.ListFeatures` method.
+ The request object. Request message for ``GkeHub.ListFeatures`` method.
  parent (str):
  Required. The parent (project and location) where the
  Features will be listed. Specified in the format
@@ -753,8 +751,7 @@ def sample_get_membership():
 
  Args:
  request (Union[google.cloud.gkehub_v1.types.GetMembershipRequest, dict]):
- The request object. Request message for
- `GkeHub.GetMembership` method.
+ The request object. Request message for ``GkeHub.GetMembership`` method.
  name (str):
  Required. The Membership resource name in the format
  ``projects/*/locations/*/memberships/*``.
@@ -854,8 +851,7 @@ def sample_get_feature():
 
  Args:
  request (Union[google.cloud.gkehub_v1.types.GetFeatureRequest, dict]):
- The request object. Request message for
- `GkeHub.GetFeature` method.
+ The request object. Request message for ``GkeHub.GetFeature`` method.
  name (str):
  Required. The Feature resource name in the format
  ``projects/*/locations/*/features/*``
@@ -967,8 +963,8 @@ def sample_create_membership():
 
  Args:
  request (Union[google.cloud.gkehub_v1.types.CreateMembershipRequest, dict]):
- The request object. Request message for the
- `GkeHub.CreateMembership` method.
+ The request object. Request message for the ``GkeHub.CreateMembership``
+ method.
  parent (str):
  Required. The parent (project and location) where the
  Memberships will be created. Specified in the format
@@ -1112,8 +1108,7 @@ def sample_create_feature():
 
  Args:
  request (Union[google.cloud.gkehub_v1.types.CreateFeatureRequest, dict]):
- The request object. Request message for the
- `GkeHub.CreateFeature` method.
+ The request object. Request message for the ``GkeHub.CreateFeature`` method.
  parent (str):
  Required. The parent (project and location) where the
  Feature will be created. Specified in the format
@@ -1249,8 +1244,7 @@ def sample_delete_membership():
 
  Args:
  request (Union[google.cloud.gkehub_v1.types.DeleteMembershipRequest, dict]):
- The request object. Request message for
- `GkeHub.DeleteMembership` method.
+ The request object. Request message for ``GkeHub.DeleteMembership`` method.
  name (str):
  Required. The Membership resource name in the format
  ``projects/*/locations/*/memberships/*``.
@@ -1372,8 +1366,7 @@ def sample_delete_feature():
 
  Args:
  request (Union[google.cloud.gkehub_v1.types.DeleteFeatureRequest, dict]):
- The request object. Request message for
- `GkeHub.DeleteFeature` method.
+ The request object. Request message for ``GkeHub.DeleteFeature`` method.
  name (str):
  Required. The Feature resource name in the format
  ``projects/*/locations/*/features/*``.
@@ -1498,8 +1491,7 @@ def sample_update_membership():
 
  Args:
  request (Union[google.cloud.gkehub_v1.types.UpdateMembershipRequest, dict]):
- The request object. Request message for
- `GkeHub.UpdateMembership` method.
+ The request object. Request message for ``GkeHub.UpdateMembership`` method.
  name (str):
  Required. The Membership resource name in the format
  ``projects/*/locations/*/memberships/*``.
@@ -1639,8 +1631,7 @@ def sample_update_feature():
 
  Args:
  request (Union[google.cloud.gkehub_v1.types.UpdateFeatureRequest, dict]):
- The request object. Request message for
- `GkeHub.UpdateFeature` method.
+ The request object. Request message for ``GkeHub.UpdateFeature`` method.
  name (str):
  Required. The Feature resource name in the format
  ``projects/*/locations/*/features/*``.
@@ -1777,9 +1768,8 @@ def sample_generate_connect_manifest():
 
  Args:
  request (Union[google.cloud.gkehub_v1.types.GenerateConnectManifestRequest, dict]):
- The request object. Request message for
- `GkeHub.GenerateConnectManifest` method.
- .
+ The request object. Request message for ``GkeHub.GenerateConnectManifest``
+ method. .
  retry (google.api_core.retry.Retry): Designation of what errors, if any,
  should be retried.
  timeout (float): The timeout for this request.

diff --git a/packages/google-cloud-gke-hub/google/cloud/gkehub_v1/services/gke_hub/transports/rest.py b/packages/google-cloud-gke-hub/google/cloud/gkehub_v1/services/gke_hub/transports/rest.py
@@ -683,7 +683,6 @@ def __call__(
  request (~.service.CreateMembershipRequest):
  The request object. Request message for the ``GkeHub.CreateMembership``
  method.
-
  retry (google.api_core.retry.Retry): Designation of what errors, if any,
  should be retried.
  timeout (float): The timeout for this request.
@@ -948,7 +947,6 @@ def __call__(
  request (~.service.GenerateConnectManifestRequest):
  The request object. Request message for ``GkeHub.GenerateConnectManifest``
  method. .
-
  retry (google.api_core.retry.Retry): Designation of what errors, if any,
  should be retried.
  timeout (float): The timeout for this request.

diff --git a/...d-gke-hub/google/cloud/gkehub_v1beta1/services/gke_hub_membership_service/async_client.py b/...d-gke-hub/google/cloud/gkehub_v1beta1/services/gke_hub_membership_service/async_client.py
@@ -282,7 +282,7 @@ async def sample_list_memberships():
  Args:
  request (Optional[Union[google.cloud.gkehub_v1beta1.types.ListMembershipsRequest, dict]]):
  The request object. Request message for
- `GkeHubMembershipService.ListMemberships` method.
+ ``GkeHubMembershipService.ListMemberships`` method.
  parent (:class:`str`):
  Required. The parent (project and location) where the
  Memberships will be listed. Specified in the format
@@ -397,7 +397,7 @@ async def sample_get_membership():
  Args:
  request (Optional[Union[google.cloud.gkehub_v1beta1.types.GetMembershipRequest, dict]]):
  The request object. Request message for
- `GkeHubMembershipService.GetMembership` method.
+ ``GkeHubMembershipService.GetMembership`` method.
  name (:class:`str`):
  Required. The Membership resource name in the format
  ``projects/*/locations/*/memberships/*``.
@@ -510,7 +510,7 @@ async def sample_create_membership():
  Args:
  request (Optional[Union[google.cloud.gkehub_v1beta1.types.CreateMembershipRequest, dict]]):
  The request object. Request message for the
- `GkeHubMembershipService.CreateMembership` method.
+ ``GkeHubMembershipService.CreateMembership`` method.
  parent (:class:`str`):
  Required. The parent (project and location) where the
  Memberships will be created. Specified in the format
@@ -659,7 +659,7 @@ async def sample_delete_membership():
  Args:
  request (Optional[Union[google.cloud.gkehub_v1beta1.types.DeleteMembershipRequest, dict]]):
  The request object. Request message for
- `GkeHubMembershipService.DeleteMembership` method.
+ ``GkeHubMembershipService.DeleteMembership`` method.
  name (:class:`str`):
  Required. The Membership resource name in the format
  ``projects/*/locations/*/memberships/*``.
@@ -785,7 +785,7 @@ async def sample_update_membership():
  Args:
  request (Optional[Union[google.cloud.gkehub_v1beta1.types.UpdateMembershipRequest, dict]]):
  The request object. Request message for
- `GkeHubMembershipService.UpdateMembership` method.
+ ``GkeHubMembershipService.UpdateMembership`` method.
  name (:class:`str`):
  Required. The membership resource name in the format:
  ``projects/[project_id]/locations/global/memberships/[membership_id]``
@@ -928,7 +928,7 @@ async def sample_generate_connect_manifest():
  Args:
  request (Optional[Union[google.cloud.gkehub_v1beta1.types.GenerateConnectManifestRequest, dict]]):
  The request object. Request message for
- `GkeHubMembershipService.GenerateConnectManifest`
+ ``GkeHubMembershipService.GenerateConnectManifest``
  method. .
  retry (google.api_core.retry.Retry): Designation of what errors, if any,
  should be retried.
@@ -1013,7 +1013,8 @@ async def sample_validate_exclusivity():
  Args:
  request (Optional[Union[google.cloud.gkehub_v1beta1.types.ValidateExclusivityRequest, dict]]):
  The request object. The request to validate the existing
- state of the membership CR in the cluster.
+ state of the membership CR in the
+ cluster.
  retry (google.api_core.retry.Retry): Designation of what errors, if any,
  should be retried.
  timeout (float): The timeout for this request.
@@ -1107,8 +1108,8 @@ async def sample_generate_exclusivity_manifest():
 
  Args:
  request (Optional[Union[google.cloud.gkehub_v1beta1.types.GenerateExclusivityManifestRequest, dict]]):
- The request object. The request to generate the
- manifests for exclusivity artifacts.
+ The request object. The request to generate the manifests
+ for exclusivity artifacts.
  retry (google.api_core.retry.Retry): Designation of what errors, if any,
  should be retried.
  timeout (float): The timeout for this request.