Skip to content

Docs/11104 jsx comments docstrings#11468

Closed
TanKaizokuO wants to merge 3 commits into
deepset-ai:mainfrom
TanKaizokuO:docs/11104-jsx-comments-docstrings
Closed

Docs/11104 jsx comments docstrings#11468
TanKaizokuO wants to merge 3 commits into
deepset-ai:mainfrom
TanKaizokuO:docs/11104-jsx-comments-docstrings

Conversation

@TanKaizokuO
Copy link
Copy Markdown

Related Issues

Proposed Changes

Enabled 8 additional docstring snippets to run in CI by removing <!-- test-ignore --> markers and making examples deterministic.

  • Replaced invalid file references with test assets or ByteStream.
  • Mocked OpenAI, Sentence Transformers, Hugging Face, and OpenAPI dependencies to avoid external services, model downloads, and network access during validation.
  • Updated affected converter, embedder, extractor, and connector docstring examples.

How did you test it?

  • Regenerated docs with hatch run docs.

  • Validated snippets using docs-website/scripts/test_python_snippets.py.

  • Verified 8 additional snippets now pass.

  • Ran formatting and type checks:

    • hatch run fmt
    • hatch run test:types

Notes for the reviewer

  • Changes are limited to documentation examples.
  • No runtime behavior was modified.
  • All removed <!-- test-ignore --> markers were verified through the snippet validation pipeline.

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 a conventional commit type for my PR title.
  • I have documented my code.
  • I have added a release note file.
  • I have run pre-commit hooks and fixed any issue.

@TanKaizokuO TanKaizokuO requested a review from a team as a code owner June 1, 2026 15:22
@TanKaizokuO TanKaizokuO requested review from sjrl and removed request for a team June 1, 2026 15:22
@vercel
Copy link
Copy Markdown

vercel Bot commented Jun 1, 2026

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

A member of the Team first needs to authorize it.

Copy link
Copy Markdown
Member

@anakin87 anakin87 left a comment

Choose a reason for hiding this comment

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

Thanks for the PR but I see 2 problems

  • Mocking the components in docstrings makes docstrings useless
  • Adopting JSX comments (#11104) is hard, we already failed once, so I'd not do this in this PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Allow more docstrings code snippets to run in the CI

2 participants