Commit a3521701 authored by BO ZHANG's avatar BO ZHANG 🏀
Browse files

update CsstStatus example

parent ceb12b0b

csst_common/status.py

+5 −5
Original line number Diff line number Diff line
@@ -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: