docs: fix grammar in Azure generator docstring examples#11337
Merged
sjrl merged 1 commit intoMay 19, 2026
Conversation
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.
|
@Aarkin7 is attempting to deploy a commit to the deepset Team on Vercel. A member of the Team first needs to authorize it. |
Contributor
|
@Aarkin7 thanks for the contribution! Please make sure to sign the CLA agreement #11337 (comment) so we can accept your contribution. |
Contributor
Author
|
Thanks for the fast turnaround @sjrl. Glad to get a first contribution in. Will keep an eye out for more. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Related Issues
N/A — trivial docstring grammar fix.
Proposed Changes:
Fixes a missing word and a stray double space in the docstring code examples for
AzureOpenAIGeneratorandAzureOpenAIChatGenerator:"<this a model name, e.g. gpt-4.1-mini>"→"<this is a model name, e.g. gpt-4.1-mini>"inhaystack/components/generators/azure.py"<this a model name, e.g. gpt-4.1-mini>"→"<this is a model name, e.g. gpt-4.1-mini>"inhaystack/components/generators/chat/azure.pyThese docstrings are rendered in the public API reference and are commonly copy-pasted by users setting up Azure OpenAI deployments.
How did you test it?
Visual review of the diff. No behavior change — string-literal content inside docstring code blocks. No unit tests apply.
Notes for the reviewer
Release note added under
releasenotes/notes/following the precedent set bycodespell-d4a32b9c589ca26e.yaml. Happy to drop it if you'd prefer to label the PRignore-for-release-notes.Checklist
fix:,feat:,build:,chore:,ci:,docs:,style:,refactor:,perf:,test:and added!in case the PR includes breaking changes.