docs: clarify GuardrailFunctionOutput docstrings #1145
Closed
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 update refines the inline documentation for the `GuardrailFunctionOutput` class by rewording the `output_info` and `tripwire_triggered` docstrings to be more concise and precise. No code behavior or public API signatures have changed.
This update refines the inline documentation for the `GuardrailFunctionOutput` class by rewording the `output_info` and `tripwire_triggered` docstrings to be more concise and precise. ✓ No code behavior or public API signatures have changed. ✓ This is purely a documentation enhancement to improve clarity for future maintainers and users.
This update refines the inline documentation for the `GuardrailFunctionOutput` class by rewording the `output_info` and `tripwire_triggered` docstrings to be more concise and precise. ✓ No code behavior or public API signatures have changed. ✓ This is purely a documentation enhancement to improve clarity for future maintainers and users.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 update refines the inline documentation for the
GuardrailFunctionOutputclass by rewording theoutput_infoandtripwire_triggereddocstrings to be more concise and precise.No code behavior or public API signatures have changed.