Skip to content

Commit 8f1ed6c

Browse files
authored
Tweak on guardrail docstrings (#1260)
1 parent 7e632c2 commit 8f1ed6c

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

src/agents/guardrail.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,9 @@ class InputGuardrail(Generic[TContext]):
7878
You can use the `@input_guardrail()` decorator to turn a function into an `InputGuardrail`, or
7979
create an `InputGuardrail` manually.
8080
81-
Guardrails return a `GuardrailResult`. If `result.tripwire_triggered` is `True`, the agent
82-
execution will immediately stop and a `InputGuardrailTripwireTriggered` exception will be raised
81+
Guardrails return a `GuardrailResult`. If `result.tripwire_triggered` is `True`,
82+
the agent's execution will immediately stop, and
83+
an `InputGuardrailTripwireTriggered` exception will be raised
8384
"""
8485

8586
guardrail_function: Callable[
@@ -132,7 +133,7 @@ class OutputGuardrail(Generic[TContext]):
132133
You can use the `@output_guardrail()` decorator to turn a function into an `OutputGuardrail`,
133134
or create an `OutputGuardrail` manually.
134135
135-
Guardrails return a `GuardrailResult`. If `result.tripwire_triggered` is `True`, a
136+
Guardrails return a `GuardrailResult`. If `result.tripwire_triggered` is `True`, an
136137
`OutputGuardrailTripwireTriggered` exception will be raised.
137138
"""
138139

@@ -316,7 +317,7 @@ def decorator(
316317
) -> OutputGuardrail[TContext_co]:
317318
return OutputGuardrail(
318319
guardrail_function=f,
319-
# Guardrail name defaults to function name when not specified (None).
320+
# Guardrail name defaults to function's name when not specified (None).
320321
name=name if name else f.__name__,
321322
)
322323

0 commit comments

Comments
 (0)