:class:`RuleStatus`
===================


.. py:class:: src.ansys.pre_commit_hooks.quality_rules.common.RuleStatus

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`


   
   Public status of a quality rule.
















   ..
       !! processed by numpydoc !!



.. py:currentmodule:: RuleStatus

Overview
--------

.. tab-set::





   .. tab-item:: Attributes

      .. list-table::
          :header-rows: 0
          :widths: auto

          * - :py:attr:`~PASSED`
            - 
          * - :py:attr:`~WARNING`
            - 
          * - :py:attr:`~ERROR`
            - 



   .. tab-item:: Special methods

      .. list-table::
          :header-rows: 0
          :widths: auto

          * - :py:attr:`~__str__`
            - Return the string representation of the status.




Import detail
-------------

.. code-block:: python

    from src.ansys.pre_commit_hooks.quality_rules.common import RuleStatus


Attribute detail
----------------

.. py:attribute:: PASSED
   :value: 'PASSED'


.. py:attribute:: WARNING
   :value: 'WARNING'


.. py:attribute:: ERROR
   :value: 'ERROR'




Method detail
-------------

.. py:method:: __str__() -> str

   
   Return the string representation of the status.
















   ..
       !! processed by numpydoc !!