diff options
Diffstat (limited to 'pw_status/py/pw_status/__init__.py')
| -rw-r--r-- | pw_status/py/pw_status/__init__.py | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/pw_status/py/pw_status/__init__.py b/pw_status/py/pw_status/__init__.py index 7fcc19e98..527afb7dc 100644 --- a/pw_status/py/pw_status/__init__.py +++ b/pw_status/py/pw_status/__init__.py @@ -17,6 +17,13 @@ import enum class Status(enum.Enum): + """Pigweed status codes. + + The status codes are described at + https://pigweed.dev/pw_status#status-codes. Consult that guide when deciding + which status code to use. + """ + OK = 0 CANCELLED = 1 UNKNOWN = 2 |