diff --git a/csst_common/status.py b/csst_common/status.py index 9f8c6b71144b028abc8b3c777799a39911939a16..0a3c14a9c90d31369aafb34468eb9c54b078d45d 100644 --- a/csst_common/status.py +++ b/csst_common/status.py @@ -8,6 +8,7 @@ Modified-History: 2022-10-04, Bo Zhang, created 2022-10-04, Bo Zhang, added CsstStatus 2022-10-07, Bo Zhang, added Numpydoc docstring + 2023-12-19, Bo Zhang, updated example """ from enum import IntEnum from typing import Optional, Any @@ -22,16 +23,15 @@ class CsstStatus(IntEnum): Examples -------- - >>> def f(num): - >>> if num > 0: - >>> return CsstStatus.PERFECT - >>> return CsstStatus.ERROR + >>> CsstStatus(0) # SUCCESS + >>> CsstStatus(1) # WARNING + >>> CsstStatus(2) # ERROR """ + # status list to be completed PERFECT = 0 WARNING = 1 ERROR = 2 - # status list to be completed class CsstResult: