fix(python): add request options parameter name to readme snippets (#…

…4756)
fern-api · Sep 26, 2024 · fe56df4 · fe56df4
1 parent 90643d4
commit fe56df4
Show file tree

Hide file tree

Showing 85 changed files with 173 additions and 271 deletions.
diff --git a/generators/python/sdk/versions.yml b/generators/python/sdk/versions.yml
@@ -1,4 +1,10 @@
-# For unreleased changes, use unreleased.yml 
+# For unreleased changes, use unreleased.yml
+- version: 4.2.7-rc4
+  irVersion: 53
+  changelogEntry:
+    - type: fix
+      summary: Generated readmes now include the parameter name required for the request options parameter within the example snippets.
+
 - version: 4.2.7-rc3
   irVersion: 53
   changelogEntry:

diff --git a/generators/python/src/fern_python/generator_cli/readme_snippet_builder.py b/generators/python/src/fern_python/generator_cli/readme_snippet_builder.py
@@ -136,7 +136,7 @@ def _client_writer(writer: AST.NodeWriter) -> None:
 {client_instantiation_str}
 
 # Override timeout for a specific method
-client.{endpoint.endpoint_package_path}{endpoint.method_name}({"..., " if has_parameters else ""}{{
+client.{endpoint.endpoint_package_path}{endpoint.method_name}({"..., " if has_parameters else ""}request_options={{
     "timeout_in_seconds": 1
 }})
 """
@@ -190,7 +190,7 @@ def _build_retries_snippets(self) -> List[str]:
             if endpoint is not None:
                 has_parameters = self._endpoint_metadata.has_parameters(endpoint_id)
                 retry_snippets.append(
-                    f"""client.{endpoint.endpoint_package_path}{endpoint.method_name}({"..., " if has_parameters else ""}{{
+                    f"""client.{endpoint.endpoint_package_path}{endpoint.method_name}({"..., " if has_parameters else ""}request_options={{
     "max_retries": 1
 }})
 """

diff --git a/seed/python-sdk/alias-extends/README.md b/seed/python-sdk/alias-extends/README.md
diff --git a/seed/python-sdk/alias/README.md b/seed/python-sdk/alias/README.md
diff --git a/seed/python-sdk/any-auth/README.md b/seed/python-sdk/any-auth/README.md
diff --git a/seed/python-sdk/api-wide-base-path/README.md b/seed/python-sdk/api-wide-base-path/README.md
diff --git a/seed/python-sdk/audiences/README.md b/seed/python-sdk/audiences/README.md
diff --git a/seed/python-sdk/auth-environment-variables/README.md b/seed/python-sdk/auth-environment-variables/README.md
diff --git a/seed/python-sdk/basic-auth-environment-variables/README.md b/seed/python-sdk/basic-auth-environment-variables/README.md
diff --git a/seed/python-sdk/basic-auth/README.md b/seed/python-sdk/basic-auth/README.md
diff --git a/seed/python-sdk/bearer-token-environment-variable/README.md b/seed/python-sdk/bearer-token-environment-variable/README.md
diff --git a/seed/python-sdk/bytes/README.md b/seed/python-sdk/bytes/README.md
diff --git a/seed/python-sdk/cross-package-type-names/README.md b/seed/python-sdk/cross-package-type-names/README.md
diff --git a/seed/python-sdk/custom-auth/README.md b/seed/python-sdk/custom-auth/README.md
diff --git a/seed/python-sdk/enum/no-custom-config/README.md b/seed/python-sdk/enum/no-custom-config/README.md
diff --git a/seed/python-sdk/enum/real-enum-forward-compat/README.md b/seed/python-sdk/enum/real-enum-forward-compat/README.md
diff --git a/seed/python-sdk/enum/real-enum/README.md b/seed/python-sdk/enum/real-enum/README.md
diff --git a/seed/python-sdk/enum/strenum/README.md b/seed/python-sdk/enum/strenum/README.md
diff --git a/seed/python-sdk/error-property/README.md b/seed/python-sdk/error-property/README.md
diff --git a/seed/python-sdk/examples/client-filename/README.md b/seed/python-sdk/examples/client-filename/README.md
diff --git a/seed/python-sdk/examples/no-custom-config/README.md b/seed/python-sdk/examples/no-custom-config/README.md
diff --git a/seed/python-sdk/examples/readme/README.md b/seed/python-sdk/examples/readme/README.md