docs: update GuardrailFunctionOutput docstrings for clarity #1152
Conversation
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
This PR refines the inline documentation for the `GuardrailFunctionOutput` class: - Updates the class summary to “Encapsulates the result of a guardrail’s validation step.” - Enhances the `output_info` field docstring to emphasize metadata and diagnostic examples (e.g., passed/failed rules, metrics). - Clarifies the `tripwire_triggered` field docstring to explicitly describe the hard-stop behavior. ✓ Purely informational edits. ✓ No changes to type signatures or logic. These improvements boost developer readability, auto-generated documentation, and tooling support without impacting runtime behavior.
|
Thanks for sending this! However, this does not show significant difference to me. |
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.
This PR refines the inline documentation for the
GuardrailFunctionOutputclass:output_infofield docstring to emphasize metadata and diagnostic examples (e.g., passed/failed rules, metrics).tripwire_triggeredfield docstring to explicitly describe the hard-stop behavior.✓ Purely informational edits.
✓ No changes to type signatures or logic.
These improvements boost developer readability, auto-generated documentation, and tooling support without impacting runtime behavior.