fix: fix docstring code block formatting (#1206)

Add `python` to code-blocks and use a consistent number of newlines. Addresses issues identified in 219067629. Co-authored-by: Dan Lee <71398022+dandhlee@users.noreply.github.com>
googleapis · Feb 15, 2022 · 500dfe7 · 500dfe7
1 parent fd2f500
commit 500dfe7
Show file tree

Hide file tree

Showing 16 changed files with 122 additions and 182 deletions.
diff --git a/gapic/ads-templates/%namespace/%name/%version/%sub/services/%service/transports/rest.py.j2 b/gapic/ads-templates/%namespace/%name/%version/%sub/services/%service/transports/rest.py.j2
@@ -66,7 +66,7 @@ class {{ service.name }}RestInterceptor:
     These use cases and more can be enabled by injecting an
     instance of a custom subclass when constructing the {{ service.name }}RestTransport.
 
-    .. code-block:
+    .. code-block:: python
         class MyCustom{{ service.name }}Interceptor({{ service.name }}RestInterceptor):
     {% for _, method in service.methods|dictsort if not method.client_streaming %}
             def pre_{{ method.name|snake_case }}(request, metadata):

diff --git a/gapic/templates/%namespace/%name_%version/%sub/services/%service/async_client.py.j2 b/gapic/templates/%namespace/%name_%version/%sub/services/%service/async_client.py.j2
@@ -209,7 +209,7 @@ class {{ service.async_client_name }}:
 
         {% with snippet = snippet_index.get_snippet(service.name, method.name, sync=True) %}
         {% if snippet is not none %}
-        .. code-block::
+        .. code-block:: python
 
 {{ snippet.full_snippet|indent(width=12, first=True) }}
         {% endif %}

diff --git a/gapic/templates/%namespace/%name_%version/%sub/services/%service/client.py.j2 b/gapic/templates/%namespace/%name_%version/%sub/services/%service/client.py.j2
@@ -371,11 +371,10 @@ class {{ service.client_name }}(metaclass={{ service.client_name }}Meta):
             ) -> Iterable[{{ method.client_output.ident }}]:
             {% endif %}
         r"""{{ method.meta.doc|rst(width=72, indent=8) }}
-
 
         {% with snippet = snippet_index.get_snippet(service.name, method.name, sync=True) %}
         {% if snippet is not none %}
-        .. code-block::
+        .. code-block:: python
 
 {{ snippet.full_snippet|indent(width=12, first=True) }}
         {% endif %}

diff --git a/gapic/templates/%namespace/%name_%version/%sub/services/%service/transports/rest.py.j2 b/gapic/templates/%namespace/%name_%version/%sub/services/%service/transports/rest.py.j2
@@ -66,7 +66,7 @@ class {{ service.name }}RestInterceptor:
     These use cases and more can be enabled by injecting an
     instance of a custom subclass when constructing the {{ service.name }}RestTransport.
 
-    .. code-block:
+    .. code-block:: python
         class MyCustom{{ service.name }}Interceptor({{ service.name }}RestInterceptor):
     {% for _, method in service.methods|dictsort if not method.client_streaming %}
             def pre_{{ method.name|snake_case }}(request, metadata):

diff --git a/tests/integration/goldens/asset/google/cloud/asset_v1/services/asset_service/async_client.py b/tests/integration/goldens/asset/google/cloud/asset_v1/services/asset_service/async_client.py
@@ -211,7 +211,7 @@ async def export_assets(self,
         the export operation usually finishes within 5 minutes.
 
 
-        .. code-block::
+        .. code-block:: python
 
             from google.cloud import asset_v1
 
@@ -308,7 +308,7 @@ async def list_assets(self,
         paged results in response.
 
 
-        .. code-block::
+        .. code-block:: python
 
             from google.cloud import asset_v1
 
@@ -422,7 +422,7 @@ async def batch_get_assets_history(self,
         INVALID_ARGUMENT error.
 
 
-        .. code-block::
+        .. code-block:: python
 
             from google.cloud import asset_v1
 
@@ -504,7 +504,7 @@ async def create_feed(self,
         updates.
 
 
-        .. code-block::
+        .. code-block:: python
 
             from google.cloud import asset_v1
 
@@ -614,7 +614,7 @@ async def get_feed(self,
             ) -> asset_service.Feed:
         r"""Gets details about an asset feed.
 
-        .. code-block::
+        .. code-block:: python
 
             from google.cloud import asset_v1
 
@@ -723,7 +723,7 @@ async def list_feeds(self,
         project/folder/organization.
 
 
-        .. code-block::
+        .. code-block:: python
 
             from google.cloud import asset_v1
 
@@ -825,7 +825,7 @@ async def update_feed(self,
             ) -> asset_service.Feed:
         r"""Updates an asset feed configuration.
 
-        .. code-block::
+        .. code-block:: python
 
             from google.cloud import asset_v1
 
@@ -929,7 +929,7 @@ async def delete_feed(self,
             ) -> None:
         r"""Deletes an asset feed.
 
-        .. code-block::
+        .. code-block:: python
 
             from google.cloud import asset_v1
 
@@ -1025,7 +1025,7 @@ async def search_all_resources(self,
         desired scope, otherwise the request will be rejected.
 
 
-        .. code-block::
+        .. code-block:: python
 
             from google.cloud import asset_v1
 
@@ -1232,7 +1232,7 @@ async def search_all_iam_policies(self,
         desired scope, otherwise the request will be rejected.
 
 
-        .. code-block::
+        .. code-block:: python
 
             from google.cloud import asset_v1
 
@@ -1415,7 +1415,7 @@ async def analyze_iam_policy(self,
         what accesses on which resources.
 
 
-        .. code-block::
+        .. code-block:: python
 
             from google.cloud import asset_v1
 
@@ -1510,7 +1510,7 @@ async def analyze_iam_policy_longrunning(self,
         to help callers to map responses to requests.
 
 
-        .. code-block::
+        .. code-block:: python
 
             from google.cloud import asset_v1
 

diff --git a/tests/integration/goldens/asset/google/cloud/asset_v1/services/asset_service/client.py b/tests/integration/goldens/asset/google/cloud/asset_v1/services/asset_service/client.py
@@ -407,8 +407,7 @@ def export_assets(self,
         the export operation usually finishes within 5 minutes.
 
 
-
-        .. code-block::
+        .. code-block:: python
 
             from google.cloud import asset_v1
 
@@ -506,8 +505,7 @@ def list_assets(self,
         paged results in response.
 
 
-
-        .. code-block::
+        .. code-block:: python
 
             from google.cloud import asset_v1
 
@@ -621,8 +619,7 @@ def batch_get_assets_history(self,
         INVALID_ARGUMENT error.
 
 
-
-        .. code-block::
+        .. code-block:: python
 
             from google.cloud import asset_v1
 
@@ -698,8 +695,7 @@ def create_feed(self,
         updates.
 
 
-
-        .. code-block::
+        .. code-block:: python
 
             from google.cloud import asset_v1
 
@@ -809,8 +805,7 @@ def get_feed(self,
             ) -> asset_service.Feed:
         r"""Gets details about an asset feed.
 
-
-        .. code-block::
+        .. code-block:: python
 
             from google.cloud import asset_v1
 
@@ -912,8 +907,7 @@ def list_feeds(self,
         project/folder/organization.
 
 
-
-        .. code-block::
+        .. code-block:: python
 
             from google.cloud import asset_v1
 
@@ -1008,8 +1002,7 @@ def update_feed(self,
             ) -> asset_service.Feed:
         r"""Updates an asset feed configuration.
 
-
-        .. code-block::
+        .. code-block:: python
 
             from google.cloud import asset_v1
 
@@ -1113,8 +1106,7 @@ def delete_feed(self,
             ) -> None:
         r"""Deletes an asset feed.
 
-
-        .. code-block::
+        .. code-block:: python
 
             from google.cloud import asset_v1
 
@@ -1203,8 +1195,7 @@ def search_all_resources(self,
         desired scope, otherwise the request will be rejected.
 
 
-
-        .. code-block::
+        .. code-block:: python
 
             from google.cloud import asset_v1
 
@@ -1404,8 +1395,7 @@ def search_all_iam_policies(self,
         desired scope, otherwise the request will be rejected.
 
 
-
-        .. code-block::
+        .. code-block:: python
 
             from google.cloud import asset_v1
 
@@ -1581,8 +1571,7 @@ def analyze_iam_policy(self,
         what accesses on which resources.
 
 
-
-        .. code-block::
+        .. code-block:: python
 
             from google.cloud import asset_v1
 
@@ -1672,8 +1661,7 @@ def analyze_iam_policy_longrunning(self,
         to help callers to map responses to requests.
 
 
-
-        .. code-block::
+        .. code-block:: python
 
             from google.cloud import asset_v1
 

diff --git a/...on/goldens/credentials/google/iam/credentials_v1/services/iam_credentials/async_client.py b/...on/goldens/credentials/google/iam/credentials_v1/services/iam_credentials/async_client.py
@@ -209,7 +209,7 @@ async def generate_access_token(self,
         account.
 
 
-        .. code-block::
+        .. code-block:: python
 
             from google.iam import credentials_v1
 
@@ -363,7 +363,7 @@ async def generate_id_token(self,
         account.
 
 
-        .. code-block::
+        .. code-block:: python
 
             from google.iam import credentials_v1
 
@@ -510,7 +510,7 @@ async def sign_blob(self,
         private key.
 
 
-        .. code-block::
+        .. code-block:: python
 
             from google.iam import credentials_v1
 
@@ -644,7 +644,7 @@ async def sign_jwt(self,
         private key.
 
 
-        .. code-block::
+        .. code-block:: python
 
             from google.iam import credentials_v1
 

diff --git a/...egration/goldens/credentials/google/iam/credentials_v1/services/iam_credentials/client.py b/...egration/goldens/credentials/google/iam/credentials_v1/services/iam_credentials/client.py
@@ -396,8 +396,7 @@ def generate_access_token(self,
         account.
 
 
-
-        .. code-block::
+        .. code-block:: python
 
             from google.iam import credentials_v1
 
@@ -544,8 +543,7 @@ def generate_id_token(self,
         account.
 
 
-
-        .. code-block::
+        .. code-block:: python
 
             from google.iam import credentials_v1
 
@@ -685,8 +683,7 @@ def sign_blob(self,
         private key.
 
 
-
-        .. code-block::
+        .. code-block:: python
 
             from google.iam import credentials_v1
 
@@ -813,8 +810,7 @@ def sign_jwt(self,
         private key.
 
 
-
-        .. code-block::
+        .. code-block:: python
 
             from google.iam import credentials_v1