Skip to content

docs: fix grammar in Azure generator docstring examples #11337

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sjrl merged 1 commit into from
May 19, 2026
+7 −2
Merged

docs: fix grammar in Azure generator docstring examples #11337

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion haystack/components/generators/azure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ class AzureOpenAIGenerator(OpenAIGenerator):
client = AzureOpenAIGenerator(
azure_endpoint="<Your Azure endpoint e.g. `https://your-company.azure.openai.com/>",
api_key=Secret.from_token("<your-api-key>"),
azure_deployment="<this a model name, e.g. gpt-4.1-mini>")
azure_deployment="<this is a model name, e.g. gpt-4.1-mini>")
response = client.run("What's Natural Language Processing? Be brief.")
print(response)
```
Expand Down
2 changes: 1 addition & 1 deletion haystack/components/generators/chat/azure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ class AzureOpenAIChatGenerator(OpenAIChatGenerator):
client = AzureOpenAIChatGenerator(
azure_endpoint="<Your Azure endpoint e.g. `https://your-company.azure.openai.com/>",
api_key=Secret.from_token("<your-api-key>"),
azure_deployment="<this a model name, e.g. gpt-4.1-mini>")
azure_deployment="<this is a model name, e.g. gpt-4.1-mini>")
response = client.run(messages)
print(response)
```
Expand Down
5 changes: 5 additions & 0 deletions releasenotes/notes/fix-azure-generator-docstring-typo-6ca4aa1ca8fc49f5.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
enhancements:
- |
Fix grammar in the ``AzureOpenAIGenerator`` and ``AzureOpenAIChatGenerator`` docstring code examples
(``"<this a model name..."`` → ``"<this is a model name..."``) so that copy-pasted snippets read correctly.
Loading