Hide docstring content below \f in parameter descriptions too - #368
Merged
Conversation
There was a problem hiding this comment.
🟢 Approval recommended
The change is small, well-scoped, and includes a targeted regression test validating the new behavior.
Pull request overview
This PR updates tool-schema generation to consistently hide docstring content after the \\f marker, extending the behavior from function-level descriptions to parameter descriptions as well.
Changes:
- Add a shared
_strip_hidden()helper to strip docstring/parameter text after the\\fmarker. - Apply
_strip_hidden()to both the function description and each parameter description when building the tool JSON schema. - Add a regression test ensuring
\\finside a parameter description is ignored.
File summaries
| File | Description |
|---|---|
src/aviary/tools/base.py |
Centralizes and applies \\f-based stripping for function + parameter descriptions during schema generation. |
tests/test_tools.py |
Adds coverage for \\f appearing within a parameter description line. |
Review details
- Files reviewed: 2/2 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Eddie-MG
approved these changes
Sep 3, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Note the deleted comment about following FastAPI was wrong, as we have been using a different convention:
r'\f'i.e.'\\f''\f'i.e. form feed character