Skip to content

fix: Tools return rg.Stop#197

Merged
monoxgas merged 1 commit into
mainfrom
fix/tools-return-stop
Jul 14, 2025
Merged

fix: Tools return rg.Stop#197
monoxgas merged 1 commit into
mainfrom
fix/tools-return-stop

Conversation

@monoxgas
Copy link
Copy Markdown
Contributor

@monoxgas monoxgas commented Jul 14, 2025

  • Allow tools to return rg.Stop in addition to raise it
  • Some other docs cleanup.

Generated Summary

  • Added explicit handling for Stop exceptions by raising them when encountered in tool call results (in docs/api/tools.mdx and rigging/tools/base.py) to ensure immediate termination.
  • Updated the tools documentation to clarify that users can either raise or return a Stop exception, with a tip explaining the benefit of returning the exception to avoid interference from surrounding code.
  • Revised the generators documentation to include a detailed note on generator identifiers and expanded examples for better clarity.

This summary was generated with ❤️ by rigging

@monoxgas monoxgas requested a review from a team as a code owner July 14, 2025 07:37
@dreadnode-renovate-bot dreadnode-renovate-bot Bot added area/docs Changes to documentation and guides type/docs Documentation updates and improvements labels Jul 14, 2025
@monoxgas monoxgas merged commit aa59558 into main Jul 14, 2025
7 checks passed
@monoxgas monoxgas deleted the fix/tools-return-stop branch November 13, 2025 22:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/docs Changes to documentation and guides type/docs Documentation updates and improvements

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant