Skip to content

Commit 95de757

Browse files
committed
FireExit docstrings
1 parent 1937496 commit 95de757

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

fire/core.py

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -167,15 +167,17 @@ class FireExit(SystemExit):
167167
168168
The trace of the Fire program is available on the `trace` property.
169169
170-
Note:
171-
Since this exception inherits from SystemExit/BaseException, you'll have to
172-
explicitly catch it with `except SystemExit` or `except FireExit`.
170+
This exception inherits from SystemExit, so clients may explicitly catch it
171+
with `except SystemExit` or `except FireExit`. If not caught, this exception
172+
will cause the client program to exit without a stacktrace.
173173
"""
174+
174175
def __init__(self, code, component_trace):
175-
"""
176+
"""Constructs a FireExit exception.
177+
176178
Args:
177-
code (int): exit code for CLI
178-
component_trace (FireTrace): the component trace generated from running the command.
179+
code: (int) Exit code for the Fire CLI.
180+
component_trace: (FireTrace) The trace for the Fire command.
179181
"""
180182
super(FireExit, self).__init__(code)
181183
self.trace = component_trace

0 commit comments

Comments
 (0)