From 3861db587b2c5fc429c625437aaddad266446077 Mon Sep 17 00:00:00 2001 From: Aarkin7 Date: Tue, 19 May 2026 17:59:00 +0530 Subject: [PATCH] docs: fix grammar in Azure generator docstring examples Adds the missing "is" in the AzureOpenAIGenerator and AzureOpenAIChatGenerator docstring code examples so that copy-pasted snippets read correctly. Also removes a stray double space in the AzureOpenAIGenerator example. --- haystack/components/generators/azure.py | 2 +- haystack/components/generators/chat/azure.py | 2 +- .../fix-azure-generator-docstring-typo-6ca4aa1ca8fc49f5.yaml | 5 +++++ 3 files changed, 7 insertions(+), 2 deletions(-) create mode 100644 releasenotes/notes/fix-azure-generator-docstring-typo-6ca4aa1ca8fc49f5.yaml diff --git a/haystack/components/generators/azure.py b/haystack/components/generators/azure.py index acf088a600..a768a8a344 100644 --- a/haystack/components/generators/azure.py +++ b/haystack/components/generators/azure.py @@ -40,7 +40,7 @@ class AzureOpenAIGenerator(OpenAIGenerator): client = AzureOpenAIGenerator( azure_endpoint="", api_key=Secret.from_token(""), - azure_deployment="") + azure_deployment="") response = client.run("What's Natural Language Processing? Be brief.") print(response) ``` diff --git a/haystack/components/generators/chat/azure.py b/haystack/components/generators/chat/azure.py index ac3a0d0aeb..663db8a4da 100644 --- a/haystack/components/generators/chat/azure.py +++ b/haystack/components/generators/chat/azure.py @@ -53,7 +53,7 @@ class AzureOpenAIChatGenerator(OpenAIChatGenerator): client = AzureOpenAIChatGenerator( azure_endpoint="", api_key=Secret.from_token(""), - azure_deployment="") + azure_deployment="") response = client.run(messages) print(response) ``` diff --git a/releasenotes/notes/fix-azure-generator-docstring-typo-6ca4aa1ca8fc49f5.yaml b/releasenotes/notes/fix-azure-generator-docstring-typo-6ca4aa1ca8fc49f5.yaml new file mode 100644 index 0000000000..05d37204b0 --- /dev/null +++ b/releasenotes/notes/fix-azure-generator-docstring-typo-6ca4aa1ca8fc49f5.yaml @@ -0,0 +1,5 @@ +--- +enhancements: + - | + Fix grammar in the ``AzureOpenAIGenerator`` and ``AzureOpenAIChatGenerator`` docstring code examples + (``"