Skip to content

test: adding more docstring code snippets to CI tests#11030

Draft
davidsbatista wants to merge 9 commits intomainfrom
tests/run-more-docstrings-code-snippets
Draft

test: adding more docstring code snippets to CI tests#11030
davidsbatista wants to merge 9 commits intomainfrom
tests/run-more-docstrings-code-snippets

Conversation

@davidsbatista
Copy link
Copy Markdown
Contributor

Related Issues

  • fixes #issue-number

Proposed Changes:

How did you test it?

Notes for the reviewer

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
Copy link
Copy Markdown

vercel bot commented Apr 2, 2026

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

Project Deployment Actions Updated (UTC)
haystack-docs Ready Ready Preview, Comment Apr 7, 2026 1:21pm

Request Review

@github-actions github-actions bot added the type:documentation Improvements on the docs label Apr 2, 2026
@coveralls
Copy link
Copy Markdown
Collaborator

coveralls commented Apr 2, 2026

Coverage Report for CI Build 24083523329

Warning

No base build found for commit 16ee940 on main.
Coverage changes can't be calculated without a base build.
If a base build is processing, this comment will update automatically when it completes.

Coverage: 92.831%

Details

  • Patch coverage: No coverable lines changed in this PR.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

Requires a base build to compare against. How to fix this →


Coverage Stats

Coverage Status
Relevant Lines: 17158
Covered Lines: 15928
Line Coverage: 92.83%
Coverage Strength: 0.93 hits per line

💛 - Coveralls

@davidsbatista
Copy link
Copy Markdown
Contributor Author

davidsbatista commented Apr 2, 2026

  • TransformersZeroShotTextRouterhaystack/components/routers/zero_shot_text_router.py:26
  • TransformersTextRouterhaystack/components/routers/transformers_text_router.py:25
  • LLMDocumentContentExtractorhaystack/components/extractors/image/llm_document_content_extractor.py:80
  • NamedEntityExtractorhaystack/components/extractors/named_entity_extractor.py:91
  • LLMMessagesRouterhaystack/components/routers/llm_messages_router.py:23
  • HuggingFaceLocalGeneratorhaystack/components/generators/hugging_face_local.py:32
  • AzureOpenAIGeneratorhaystack/components/generators/azure.py:36
  • HuggingFaceAPIGeneratorhaystack/components/generators/hugging_face_api.py:53,67,84
  • AzureOpenAIResponsesChatGeneratorhaystack/components/generators/chat/azure_responses.py:37
  • TransformersSimilarityRankerhaystack/components/rankers/transformers_similarity.py:38
  • DocumentToImageContenthaystack/components/converters/image/document_to_image.py:37
  • FileToFileContenthaystack/components/converters/file_to_file_content.py:25
  • LocalWhisperTranscriberhaystack/components/audio/whisper_local.py:43
  • SentenceTransformersSparseDocumentEmbedderhaystack/components/embedders/sentence_transformers_sparse_document_embedder.py:28
  • HuggingFaceAPIDocumentEmbedderhaystack/components/embedders/hugging_face_api_document_embedder.py:39,58,77
  • AzureOCRDocumentConverterhaystack/components/converters/azure.py:41
  • AzureOpenAIChatGeneratorhaystack/components/generators/chat/azure.py:45
  • SentenceTransformersSparseTextEmbedderhaystack/components/embedders/sentence_transformers_sparse_text_embedder.py:25
  • SentenceTransformersDocumentEmbedderhaystack/components/embedders/sentence_transformers_document_embedder.py:28
  • HuggingFaceAPIChatGeneratorhaystack/components/generators/chat/hugging_face_api.py:266,290,317,335
  • SentenceTransformersDiversityRankerhaystack/components/rankers/sentence_transformers_diversity.py:102
  • HuggingFaceAPITextEmbedderhaystack/components/embedders/hugging_face_api_text_embedder.py:32,47,61
  • OpenAITextEmbedderhaystack/components/embedders/openai_text_embedder.py:24
  • SentenceTransformersDocumentImageEmbedderhaystack/components/embedders/image/sentence_transformers_doc_image_embedder.py:35
  • OpenAIDocumentEmbedderhaystack/components/embedders/openai_document_embedder.py:27
  • AzureOpenAIDocumentEmbedderhaystack/components/embedders/azure_document_embedder.py:24
  • SentenceTransformersTextEmbedderhaystack/components/embedders/sentence_transformers_text_embedder.py:24
  • HuggingFaceTEIRankerhaystack/components/rankers/hugging_face_tei.py:39
  • AzureOpenAITextEmbedderhaystack/components/embedders/azure_text_embedder.py:22
  • request_with_retryhaystack/utils/requests_utils.py:22

@davidsbatista davidsbatista added the ignore-for-release-notes PRs with this flag won't be included in the release notes. label Apr 2, 2026
@anakin87
Copy link
Copy Markdown
Member

anakin87 commented Apr 2, 2026

I'd exclude some of them

  • HuggingFaceLocalGenerator and HuggingFaceLocalChatGenerato: heavy and slow generative models on CPU
  • TikaDocumentConverter: requires Tika docker container running

A few others I'm unsure about

  • NamedEntityExtractor: might require spacy that is not available in the test environment (it's on e2e only)
  • LocalWhisperTranscriber: might be slow on CPU but it's worth trying

@davidsbatista davidsbatista changed the title adding LLMMessagesRouter docstring to CI tests test: adding more docstring code snippets to CI tests Apr 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ignore-for-release-notes PRs with this flag won't be included in the release notes. topic:CI type:documentation Improvements on the docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants