Skip to content

docs: fix grammar in Azure generator docstring examples#11337

Merged
sjrl merged 1 commit into
deepset-ai:mainfrom
Aarkin7:docs/fix-azure-generator-docstring-typo
May 19, 2026
Merged

docs: fix grammar in Azure generator docstring examples#11337
sjrl merged 1 commit into
deepset-ai:mainfrom
Aarkin7:docs/fix-azure-generator-docstring-typo

Conversation

@Aarkin7
Copy link
Copy Markdown
Contributor

@Aarkin7 Aarkin7 commented May 19, 2026

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 AzureOpenAIGenerator and AzureOpenAIChatGenerator:

  • "<this a model name, e.g. gpt-4.1-mini>""<this is a model name, e.g. gpt-4.1-mini>" in haystack/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>" in haystack/components/generators/chat/azure.py

These 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 by codespell-d4a32b9c589ca26e.yaml. Happy to drop it if you'd prefer to label the PR ignore-for-release-notes.

Checklist

  • I have read the contributors guidelines and the code of conduct.
  • I have updated the related issue with new insights and changes.
  • I have added unit tests and updated the docstrings.
  • I've used one of the conventional commit types for my PR title: fix:, feat:, build:, chore:, ci:, docs:, style:, refactor:, perf:, test: and added ! in case the PR includes breaking changes.
  • I have documented my code.
  • I have added a release note file, following the contributors guidelines.
  • I have run pre-commit hooks and fixed any issue.

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 Aarkin7 requested a review from a team as a code owner May 19, 2026 12:34
@Aarkin7 Aarkin7 requested review from sjrl and removed request for a team May 19, 2026 12:34
@vercel
Copy link
Copy Markdown

vercel Bot commented May 19, 2026

@Aarkin7 is attempting to deploy a commit to the deepset Team on Vercel.

A member of the Team first needs to authorize it.

@CLAassistant
Copy link
Copy Markdown

CLAassistant commented May 19, 2026

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions Bot added the type:documentation Improvements on the docs label May 19, 2026
Copy link
Copy Markdown
Contributor

@sjrl sjrl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@sjrl
Copy link
Copy Markdown
Contributor

sjrl commented May 19, 2026

@Aarkin7 thanks for the contribution! Please make sure to sign the CLA agreement #11337 (comment) so we can accept your contribution.

@sjrl sjrl self-assigned this May 19, 2026
@Aarkin7
Copy link
Copy Markdown
Contributor Author

Aarkin7 commented May 19, 2026

Thanks for the fast turnaround @sjrl. Glad to get a first contribution in. Will keep an eye out for more.

@sjrl sjrl merged commit 6c3b50d into deepset-ai:main May 19, 2026
22 of 24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type:documentation Improvements on the docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants