Skip to content

chore: Improve Agent pydoc #9997

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

chore: Improve Agent pydoc #9997

wants to merge 2 commits into from
+55 −8

Conversation

@vblagoje
Copy link
Member

  • Improves Agent pydoc with working short interesting example
  • This snippet will be in main Agent API doc and tested daily for regression and correctness

@vblagoje vblagoje requested a review from a team as a code owner October 31, 2025 13:22
@vblagoje vblagoje added the ignore-for-release-notes PRs with this flag won't be included in the release notes. label Oct 31, 2025
@vblagoje vblagoje requested review from mpangrazzi and removed request for a team October 31, 2025 13:22
@vercel
Copy link

vercel bot commented Oct 31, 2025

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

1 Skipped Deployment
Project Deployment Preview Comments Updated (UTC)
haystack-docs Ignored Ignored Oct 31, 2025 1:22pm

@vblagoje vblagoje requested a review from sjrl October 31, 2025 13:22
@github-actions github-actions bot added the type:documentation Improvements on the docs label Oct 31, 2025
@vblagoje vblagoje requested a review from dfokina October 31, 2025 13:22
@vblagoje
Copy link
Member Author

Required for #9967 and in general

@coveralls
Copy link
Collaborator

Pull Request Test Coverage Report for Build 18973871862

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 9 unchanged lines in 1 file lost coverage.
  • Overall coverage increased (+0.02%) to 92.244%
Files with Coverage Reduction New Missed Lines %
components/agents/agent.py 9 96.48%
Totals Coverage Status
Change from base Build 18971464217: 0.02%
Covered Lines: 13498
Relevant Lines: 14633
💛 - Coveralls

dfokina
dfokina approved these changes Oct 31, 2025
View reviewed changes
Copy link
Contributor

@dfokina dfokina left a comment

Choose a reason for hiding this comment

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

👍

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

Reviewers

@dfokina dfokina dfokina approved these changes

@mpangrazzi mpangrazzi Awaiting requested review from mpangrazzi mpangrazzi is a code owner automatically assigned from deepset-ai/open-source-engineering

@sjrl sjrl Awaiting requested review from sjrl

Assignees

No one assigned

Labels

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

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@vblagoje @coveralls @dfokina