suricata_check.checkers.styleguide.reference
============================================

.. py:module:: suricata_check.checkers.styleguide.reference

.. autoapi-nested-parse::

   `ReferenceChecker`.



Classes
-------

.. autoapisummary::

   suricata_check.checkers.styleguide.reference.ReferenceChecker


Module Contents
---------------

.. py:class:: ReferenceChecker(include: Optional[collections.abc.Iterable[str]] = None)

   Bases: :py:obj:`suricata_check.checkers.interface.CheckerInterface`


   The `ReferenceChecker` contains several checks for Suricata reference option.

   Codes S700-710 report on non-standard usages of `reference`

   Initializes the checker given a list of issue codes to emit.


   .. py:attribute:: codes

      A Mapping of issue codes emitted by the checker to metadata for those issue types.
      The metadata is structured in the form of a Mapping from attribute name to attribute value.
      The one mandatory metadata attribute is severity, which must be one of the levels provided by the `logging` module