Skip to content

Conversation

@sjrl
Copy link
Contributor

@sjrl sjrl commented Jan 22, 2026

Related Issues

  • fixes #issue-number

Proposed Changes:

While working on adding human in the loop I noticed we were missing some api docs for a few modules.

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.

@sjrl sjrl requested a review from a team as a code owner January 22, 2026 07:36
@sjrl sjrl requested review from anakin87 and removed request for a team January 22, 2026 07:36
@vercel
Copy link

vercel bot commented Jan 22, 2026

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

1 Skipped Deployment
Project Deployment Review Updated (UTC)
haystack-docs Ignored Ignored Preview Jan 22, 2026 8:25am

Request Review

@sjrl sjrl self-assigned this Jan 22, 2026
@sjrl
Copy link
Contributor Author

sjrl commented Jan 22, 2026

@anakin87 I added the utils for a few modules since they contained public functions that I think make sense to highlight, but I'm open to discussion.

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

Thank you!

In general, I am not sure about exposing utils modules: they contain public functions but are primarily intended for internal use. In any case, I'll leave the decision up to you.

@sjrl
Copy link
Contributor Author

sjrl commented Jan 22, 2026

I decided to remove the utils since you're right they are meant to be used internally in components.

@sjrl sjrl enabled auto-merge (squash) January 22, 2026 08:25
@sjrl sjrl merged commit f9153d7 into main Jan 22, 2026
10 checks passed
@sjrl sjrl deleted the missing-pydoc-api branch January 22, 2026 08:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants