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

* 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 · d046295 · d046295
1 parent 706096c
commit d046295
Show file tree

Hide file tree

Showing 6 changed files with 50 additions and 94 deletions.
diff --git a/...google-cloud-recommender/google/cloud/recommender_v1/services/recommender/async_client.py b/...google-cloud-recommender/google/cloud/recommender_v1/services/recommender/async_client.py
@@ -288,8 +288,7 @@ async def sample_list_insights():
 
         Args:
             request (Optional[Union[google.cloud.recommender_v1.types.ListInsightsRequest, dict]]):
-                The request object. Request for the `ListInsights`
-                method.
+                The request object. Request for the ``ListInsights`` method.
             parent (:class:`str`):
                 Required. The container resource on which to execute the
                 request. Acceptable formats:
@@ -427,7 +426,7 @@ async def sample_get_insight():
 
         Args:
             request (Optional[Union[google.cloud.recommender_v1.types.GetInsightRequest, dict]]):
-                The request object. Request to the `GetInsight` method.
+                The request object. Request to the ``GetInsight`` method.
             name (:class:`str`):
                 Required. Name of the insight.
                 This corresponds to the ``name`` field
@@ -550,8 +549,7 @@ async def sample_mark_insight_accepted():
 
         Args:
             request (Optional[Union[google.cloud.recommender_v1.types.MarkInsightAcceptedRequest, dict]]):
-                The request object. Request for the
-                `MarkInsightAccepted` method.
+                The request object. Request for the ``MarkInsightAccepted`` method.
             name (:class:`str`):
                 Required. Name of the insight.
                 This corresponds to the ``name`` field
@@ -677,8 +675,7 @@ async def sample_list_recommendations():
 
         Args:
             request (Optional[Union[google.cloud.recommender_v1.types.ListRecommendationsRequest, dict]]):
-                The request object. Request for the
-                `ListRecommendations` method.
+                The request object. Request for the ``ListRecommendations`` method.
             parent (:class:`str`):
                 Required. The container resource on which to execute the
                 request. Acceptable formats:
@@ -846,8 +843,7 @@ async def sample_get_recommendation():
 
         Args:
             request (Optional[Union[google.cloud.recommender_v1.types.GetRecommendationRequest, dict]]):
-                The request object. Request to the `GetRecommendation`
-                method.
+                The request object. Request to the ``GetRecommendation`` method.
             name (:class:`str`):
                 Required. Name of the recommendation.
                 This corresponds to the ``name`` field
@@ -973,8 +969,7 @@ async def sample_mark_recommendation_claimed():
 
         Args:
             request (Optional[Union[google.cloud.recommender_v1.types.MarkRecommendationClaimedRequest, dict]]):
-                The request object. Request for the
-                `MarkRecommendationClaimed` Method.
+                The request object. Request for the ``MarkRecommendationClaimed`` Method.
             name (:class:`str`):
                 Required. Name of the recommendation.
                 This corresponds to the ``name`` field
@@ -1112,8 +1107,7 @@ async def sample_mark_recommendation_succeeded():
 
         Args:
             request (Optional[Union[google.cloud.recommender_v1.types.MarkRecommendationSucceededRequest, dict]]):
-                The request object. Request for the
-                `MarkRecommendationSucceeded` Method.
+                The request object. Request for the ``MarkRecommendationSucceeded`` Method.
             name (:class:`str`):
                 Required. Name of the recommendation.
                 This corresponds to the ``name`` field
@@ -1251,8 +1245,7 @@ async def sample_mark_recommendation_failed():
 
         Args:
             request (Optional[Union[google.cloud.recommender_v1.types.MarkRecommendationFailedRequest, dict]]):
-                The request object. Request for the
-                `MarkRecommendationFailed` Method.
+                The request object. Request for the ``MarkRecommendationFailed`` Method.
             name (:class:`str`):
                 Required. Name of the recommendation.
                 This corresponds to the ``name`` field
@@ -1378,8 +1371,7 @@ async def sample_get_recommender_config():
 
         Args:
             request (Optional[Union[google.cloud.recommender_v1.types.GetRecommenderConfigRequest, dict]]):
-                The request object. Request for the
-                GetRecommenderConfig` method.
+                The request object. Request for the GetRecommenderConfig\` method.
             name (:class:`str`):
                 Required. Name of the Recommendation Config to get.
 
@@ -1488,8 +1480,7 @@ async def sample_update_recommender_config():
 
         Args:
             request (Optional[Union[google.cloud.recommender_v1.types.UpdateRecommenderConfigRequest, dict]]):
-                The request object. Request for the
-                `UpdateRecommenderConfig` method.
+                The request object. Request for the ``UpdateRecommenderConfig`` method.
             recommender_config (:class:`google.cloud.recommender_v1.types.RecommenderConfig`):
                 Required. The RecommenderConfig to
                 update.
@@ -1600,8 +1591,7 @@ async def sample_get_insight_type_config():
 
         Args:
             request (Optional[Union[google.cloud.recommender_v1.types.GetInsightTypeConfigRequest, dict]]):
-                The request object. Request for the
-                GetInsightTypeConfig` method.
+                The request object. Request for the GetInsightTypeConfig\` method.
             name (:class:`str`):
                 Required. Name of the InsightTypeConfig to get.
 
@@ -1710,8 +1700,7 @@ async def sample_update_insight_type_config():
 
         Args:
             request (Optional[Union[google.cloud.recommender_v1.types.UpdateInsightTypeConfigRequest, dict]]):
-                The request object. Request for the
-                `UpdateInsightTypeConfig` method.
+                The request object. Request for the ``UpdateInsightTypeConfig`` method.
             insight_type_config (:class:`google.cloud.recommender_v1.types.InsightTypeConfig`):
                 Required. The InsightTypeConfig to
                 update.

diff --git a/packages/google-cloud-recommender/google/cloud/recommender_v1/services/recommender/client.py b/packages/google-cloud-recommender/google/cloud/recommender_v1/services/recommender/client.py
@@ -619,8 +619,7 @@ def sample_list_insights():
 
         Args:
             request (Union[google.cloud.recommender_v1.types.ListInsightsRequest, dict]):
-                The request object. Request for the `ListInsights`
-                method.
+                The request object. Request for the ``ListInsights`` method.
             parent (str):
                 Required. The container resource on which to execute the
                 request. Acceptable formats:
@@ -748,7 +747,7 @@ def sample_get_insight():
 
         Args:
             request (Union[google.cloud.recommender_v1.types.GetInsightRequest, dict]):
-                The request object. Request to the `GetInsight` method.
+                The request object. Request to the ``GetInsight`` method.
             name (str):
                 Required. Name of the insight.
                 This corresponds to the ``name`` field
@@ -861,8 +860,7 @@ def sample_mark_insight_accepted():
 
         Args:
             request (Union[google.cloud.recommender_v1.types.MarkInsightAcceptedRequest, dict]):
-                The request object. Request for the
-                `MarkInsightAccepted` method.
+                The request object. Request for the ``MarkInsightAccepted`` method.
             name (str):
                 Required. Name of the insight.
                 This corresponds to the ``name`` field
@@ -987,8 +985,7 @@ def sample_list_recommendations():
 
         Args:
             request (Union[google.cloud.recommender_v1.types.ListRecommendationsRequest, dict]):
-                The request object. Request for the
-                `ListRecommendations` method.
+                The request object. Request for the ``ListRecommendations`` method.
             parent (str):
                 Required. The container resource on which to execute the
                 request. Acceptable formats:
@@ -1146,8 +1143,7 @@ def sample_get_recommendation():
 
         Args:
             request (Union[google.cloud.recommender_v1.types.GetRecommendationRequest, dict]):
-                The request object. Request to the `GetRecommendation`
-                method.
+                The request object. Request to the ``GetRecommendation`` method.
             name (str):
                 Required. Name of the recommendation.
                 This corresponds to the ``name`` field
@@ -1263,8 +1259,7 @@ def sample_mark_recommendation_claimed():
 
         Args:
             request (Union[google.cloud.recommender_v1.types.MarkRecommendationClaimedRequest, dict]):
-                The request object. Request for the
-                `MarkRecommendationClaimed` Method.
+                The request object. Request for the ``MarkRecommendationClaimed`` Method.
             name (str):
                 Required. Name of the recommendation.
                 This corresponds to the ``name`` field
@@ -1405,8 +1400,7 @@ def sample_mark_recommendation_succeeded():
 
         Args:
             request (Union[google.cloud.recommender_v1.types.MarkRecommendationSucceededRequest, dict]):
-                The request object. Request for the
-                `MarkRecommendationSucceeded` Method.
+                The request object. Request for the ``MarkRecommendationSucceeded`` Method.
             name (str):
                 Required. Name of the recommendation.
                 This corresponds to the ``name`` field
@@ -1547,8 +1541,7 @@ def sample_mark_recommendation_failed():
 
         Args:
             request (Union[google.cloud.recommender_v1.types.MarkRecommendationFailedRequest, dict]):
-                The request object. Request for the
-                `MarkRecommendationFailed` Method.
+                The request object. Request for the ``MarkRecommendationFailed`` Method.
             name (str):
                 Required. Name of the recommendation.
                 This corresponds to the ``name`` field
@@ -1675,8 +1668,7 @@ def sample_get_recommender_config():
 
         Args:
             request (Union[google.cloud.recommender_v1.types.GetRecommenderConfigRequest, dict]):
-                The request object. Request for the
-                GetRecommenderConfig` method.
+                The request object. Request for the GetRecommenderConfig\` method.
             name (str):
                 Required. Name of the Recommendation Config to get.
 
@@ -1785,8 +1777,7 @@ def sample_update_recommender_config():
 
         Args:
             request (Union[google.cloud.recommender_v1.types.UpdateRecommenderConfigRequest, dict]):
-                The request object. Request for the
-                `UpdateRecommenderConfig` method.
+                The request object. Request for the ``UpdateRecommenderConfig`` method.
             recommender_config (google.cloud.recommender_v1.types.RecommenderConfig):
                 Required. The RecommenderConfig to
                 update.
@@ -1899,8 +1890,7 @@ def sample_get_insight_type_config():
 
         Args:
             request (Union[google.cloud.recommender_v1.types.GetInsightTypeConfigRequest, dict]):
-                The request object. Request for the
-                GetInsightTypeConfig` method.
+                The request object. Request for the GetInsightTypeConfig\` method.
             name (str):
                 Required. Name of the InsightTypeConfig to get.
 
@@ -2009,8 +1999,7 @@ def sample_update_insight_type_config():
 
         Args:
             request (Union[google.cloud.recommender_v1.types.UpdateInsightTypeConfigRequest, dict]):
-                The request object. Request for the
-                `UpdateInsightTypeConfig` method.
+                The request object. Request for the ``UpdateInsightTypeConfig`` method.
             insight_type_config (google.cloud.recommender_v1.types.InsightTypeConfig):
                 Required. The InsightTypeConfig to
                 update.

diff --git a/...e-cloud-recommender/google/cloud/recommender_v1beta1/services/recommender/async_client.py b/...e-cloud-recommender/google/cloud/recommender_v1beta1/services/recommender/async_client.py
@@ -288,8 +288,7 @@ async def sample_list_insights():
 
         Args:
             request (Optional[Union[google.cloud.recommender_v1beta1.types.ListInsightsRequest, dict]]):
-                The request object. Request for the `ListInsights`
-                method.
+                The request object. Request for the ``ListInsights`` method.
             parent (:class:`str`):
                 Required. The container resource on which to execute the
                 request. Acceptable formats:
@@ -427,7 +426,7 @@ async def sample_get_insight():
 
         Args:
             request (Optional[Union[google.cloud.recommender_v1beta1.types.GetInsightRequest, dict]]):
-                The request object. Request to the `GetInsight` method.
+                The request object. Request to the ``GetInsight`` method.
             name (:class:`str`):
                 Required. Name of the insight.
                 This corresponds to the ``name`` field
@@ -550,8 +549,7 @@ async def sample_mark_insight_accepted():
 
         Args:
             request (Optional[Union[google.cloud.recommender_v1beta1.types.MarkInsightAcceptedRequest, dict]]):
-                The request object. Request for the
-                `MarkInsightAccepted` method.
+                The request object. Request for the ``MarkInsightAccepted`` method.
             name (:class:`str`):
                 Required. Name of the insight.
                 This corresponds to the ``name`` field
@@ -677,8 +675,7 @@ async def sample_list_recommendations():
 
         Args:
             request (Optional[Union[google.cloud.recommender_v1beta1.types.ListRecommendationsRequest, dict]]):
-                The request object. Request for the
-                `ListRecommendations` method.
+                The request object. Request for the ``ListRecommendations`` method.
             parent (:class:`str`):
                 Required. The container resource on which to execute the
                 request. Acceptable formats:
@@ -846,8 +843,7 @@ async def sample_get_recommendation():
 
         Args:
             request (Optional[Union[google.cloud.recommender_v1beta1.types.GetRecommendationRequest, dict]]):
-                The request object. Request to the `GetRecommendation`
-                method.
+                The request object. Request to the ``GetRecommendation`` method.
             name (:class:`str`):
                 Required. Name of the recommendation.
                 This corresponds to the ``name`` field
@@ -973,8 +969,7 @@ async def sample_mark_recommendation_claimed():
 
         Args:
             request (Optional[Union[google.cloud.recommender_v1beta1.types.MarkRecommendationClaimedRequest, dict]]):
-                The request object. Request for the
-                `MarkRecommendationClaimed` Method.
+                The request object. Request for the ``MarkRecommendationClaimed`` Method.
             name (:class:`str`):
                 Required. Name of the recommendation.
                 This corresponds to the ``name`` field
@@ -1112,8 +1107,7 @@ async def sample_mark_recommendation_succeeded():
 
         Args:
             request (Optional[Union[google.cloud.recommender_v1beta1.types.MarkRecommendationSucceededRequest, dict]]):
-                The request object. Request for the
-                `MarkRecommendationSucceeded` Method.
+                The request object. Request for the ``MarkRecommendationSucceeded`` Method.
             name (:class:`str`):
                 Required. Name of the recommendation.
                 This corresponds to the ``name`` field
@@ -1251,8 +1245,7 @@ async def sample_mark_recommendation_failed():
 
         Args:
             request (Optional[Union[google.cloud.recommender_v1beta1.types.MarkRecommendationFailedRequest, dict]]):
-                The request object. Request for the
-                `MarkRecommendationFailed` Method.
+                The request object. Request for the ``MarkRecommendationFailed`` Method.
             name (:class:`str`):
                 Required. Name of the recommendation.
                 This corresponds to the ``name`` field
@@ -1378,8 +1371,7 @@ async def sample_get_recommender_config():
 
         Args:
             request (Optional[Union[google.cloud.recommender_v1beta1.types.GetRecommenderConfigRequest, dict]]):
-                The request object. Request for the
-                GetRecommenderConfig` method.
+                The request object. Request for the GetRecommenderConfig\` method.
             name (:class:`str`):
                 Required. Name of the Recommendation Config to get.
 
@@ -1488,8 +1480,7 @@ async def sample_update_recommender_config():
 
         Args:
             request (Optional[Union[google.cloud.recommender_v1beta1.types.UpdateRecommenderConfigRequest, dict]]):
-                The request object. Request for the
-                `UpdateRecommenderConfig` method.
+                The request object. Request for the ``UpdateRecommenderConfig`` method.
             recommender_config (:class:`google.cloud.recommender_v1beta1.types.RecommenderConfig`):
                 Required. The RecommenderConfig to
                 update.
@@ -1600,8 +1591,7 @@ async def sample_get_insight_type_config():
 
         Args:
             request (Optional[Union[google.cloud.recommender_v1beta1.types.GetInsightTypeConfigRequest, dict]]):
-                The request object. Request for the
-                GetInsightTypeConfig` method.
+                The request object. Request for the GetInsightTypeConfig\` method.
             name (:class:`str`):
                 Required. Name of the InsightTypeConfig to get.
 
@@ -1710,8 +1700,7 @@ async def sample_update_insight_type_config():
 
         Args:
             request (Optional[Union[google.cloud.recommender_v1beta1.types.UpdateInsightTypeConfigRequest, dict]]):
-                The request object. Request for the
-                `UpdateInsightTypeConfig` method.
+                The request object. Request for the ``UpdateInsightTypeConfig`` method.
             insight_type_config (:class:`google.cloud.recommender_v1beta1.types.InsightTypeConfig`):
                 Required. The InsightTypeConfig to
                 update.