Best Practice#
This section provides a brief overview of best coding practice. Knowing that coding standards may change over time, the information provided below reflects principals established by the community and documented in the PEP8 style guide.
Docstrings#
One important part of open-source work is to provide sufficient information on classes and methods for others to use. The main source of information is provided as a block of text, also referred to as docstring, directly below the signature of the method. The information should be written in plain English with a list of input arguments. Different styles are possible and generally agreed upon by the development team.
Regardless of the style chosen, it is all about consistency.
In this tutorial, we follow the sphinx-reST style as it is compact and standard format with Pycharm used for code development.
Copyright (c) 2022 Mira Geoscience Ltd.