Skip to content

docs: fix failing python code snippets - #12002

Merged
anakin87 merged 2 commits into
mainfrom
fix-snippets-3
Jul 14, 2026
Merged

docs: fix failing python code snippets#12002
anakin87 merged 2 commits into
mainfrom
fix-snippets-3

Conversation

@anakin87

@anakin87 anakin87 commented Jul 14, 2026

Copy link
Copy Markdown
Member

Related Issues

Proposed Changes:

  • fix some buggy code snippets
  • expand some snippets of them to make them runnable
  • install a missing dependency for LLMMessagesRouter example
  • skip testing some snippets where making them actually runnable would have produced a long and unclear snippet

How did you test it?

I locally ran:

hatch run docs
hatch -e test env run -- pip install huggingface-api-haystack
hatch -e test env run -- python docs-website/scripts/test_python_snippets.py --verbose tmp_api_reference/

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.

@vercel

vercel Bot commented Jul 14, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
Project Deployment Actions Updated (UTC)
haystack-docs Ignored Ignored Preview Jul 14, 2026 10:43am

Request Review

@github-actions github-actions Bot added topic:CI type:documentation Improvements on the docs labels Jul 14, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Coverage report

This PR does not seem to contain any modification to coverable code.

@anakin87 anakin87 self-assigned this Jul 14, 2026
@anakin87
anakin87 marked this pull request as ready for review July 14, 2026 09:58
@anakin87
anakin87 requested a review from a team as a code owner July 14, 2026 09:58
@anakin87
anakin87 requested review from bogdankostic and davidsbatista and removed request for a team and bogdankostic July 14, 2026 09:58
@davidsbatista

Copy link
Copy Markdown
Contributor

nice! thanks for this 👍🏽

@anakin87
anakin87 enabled auto-merge (squash) July 14, 2026 10:52

@davidsbatista davidsbatista left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

looks good!

@anakin87
anakin87 merged commit 2618dae into main Jul 14, 2026
26 checks passed
@anakin87
anakin87 deleted the fix-snippets-3 branch July 14, 2026 10:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

topic:CI type:documentation Improvements on the docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants