Skip to content

updated the output to # >>#11012

Merged
davidsbatista merged 2 commits intodeepset-ai:mainfrom
Amanbig:feat/output
Apr 1, 2026
Merged

updated the output to # >>#11012
davidsbatista merged 2 commits intodeepset-ai:mainfrom
Amanbig:feat/output

Conversation

@Amanbig
Copy link
Copy Markdown
Contributor

@Amanbig Amanbig commented Apr 1, 2026

Related Issues

Proposed Changes:

Standardized the prefix used for print outputs in docstring code examples across the repository to uniformly use # >> . This fixes instances that were using inconsistent formatting (# >>> , >>> , >> , # > , and bare # ).

Files updated:

  • haystack/tools/from_function.py
  • haystack/core/component/sockets.py
  • haystack/components/tools/tool_invoker.py
  • haystack/components/generators/azure.py
  • haystack/components/builders/answer_builder.py
  • haystack/components/agents/state/state_utils.py
  • haystack/components/converters/html.py

How did you test it?

  • Visually inspected the modified files to ensure the # >> prefix is correctly applied to output snippet lines exclusively.
  • Formatting runs to ensure no regressions (strictly docstring changes, no code logic was altered).

Notes for the reviewer

  • Note: I deliberately left instances like # > comparator in document_store.py alone, as those serve as section headers rather than print output examples.
  • Because this is purely a documentation/docstring change, a release note was omitted per the contributing guidelines.

Checklist

@Amanbig Amanbig requested a review from a team as a code owner April 1, 2026 13:06
@Amanbig Amanbig requested review from bogdankostic and removed request for a team April 1, 2026 13:06
@vercel
Copy link
Copy Markdown

vercel bot commented Apr 1, 2026

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

A member of the Team first needs to authorize it.

@github-actions github-actions bot added topic:core type:documentation Improvements on the docs labels Apr 1, 2026
@davidsbatista davidsbatista requested review from davidsbatista and removed request for bogdankostic April 1, 2026 13:12
@davidsbatista davidsbatista added the ignore-for-release-notes PRs with this flag won't be included in the release notes. label Apr 1, 2026
@coveralls
Copy link
Copy Markdown
Collaborator

Pull Request Test Coverage Report for Build 23852121732

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 92.904%

Totals Coverage Status
Change from base Build 23851947089: 0.0%
Covered Lines: 15880
Relevant Lines: 17093

💛 - Coveralls

@vercel
Copy link
Copy Markdown

vercel bot commented Apr 1, 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 1, 2026 2:02pm

Request Review

Copy link
Copy Markdown
Contributor

@davidsbatista davidsbatista left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Copy Markdown
Contributor

@davidsbatista davidsbatista left a comment

Choose a reason for hiding this comment

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

Looks good!

@davidsbatista davidsbatista merged commit 4e7e451 into deepset-ai:main Apr 1, 2026
22 checks passed
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:core type:documentation Improvements on the docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Standardise print outputs in code examples

3 participants