.. _coding:

Coding Conventions
#################################

.. _fig:gpilib2_inheritance:
.. figure:: gpilib2_inheritance.png
   :width: 75.0%
   :alt: gpilib2 coronagraph class diagram

   ``gpilib2`` sample class diagram for the coronagraph object.


Checks
============

All ``gpilib2`` must have type hinting (https://docs.python.org/3/library/typing.html).  All of ``gpilib2`` must pass strict static type checking with no errors (``mypy --strict``).  ``type: ignore`` comments are allowed but must be documented and explained. 

All of ``gpilib2`` must be blackened (https://black.readthedocs.io/en/stable/) and must pass all ``pylint`` checks (except for line width).