From a3521701132299510c4e8a2ba5211191b1ea6ef3 Mon Sep 17 00:00:00 2001
From: BO ZHANG <bozhang@nao.cas.cn>
Date: Tue, 19 Dec 2023 11:23:36 +0800
Subject: [PATCH] update CsstStatus example

---
 csst_common/status.py | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/csst_common/status.py b/csst_common/status.py
index 9f8c6b7..0a3c14a 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:
-- 
GitLab