Skip to content

Commit

Permalink
Per #379, modified the Python requirements section (and modified some…
Browse files Browse the repository at this point in the history
… additional links)
  • Loading branch information
jprestop committed May 13, 2024
1 parent 3136c85 commit a8f3ba6
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions docs/Contributors_Guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,14 @@ other scripts.
Python Requirements
===================

The requirements below come directly from the **requirements.txt** file at the top level of the repository.

.. literalinclude:: ../../requirements.txt
For information about the Python Requirements for METcalcpy, please see the User’s Guide `Python Requirements <https://metcalcpy.readthedocs.io/en/develop/Users_Guide/installation.html#python-requirements>`_ section in the `Installation Guide <https://metcalcpy.readthedocs.io/en/develop/Users_Guide/installation.html#installation-guide>`_.

Coding Standards
================

METplus has adopted some coding standards for its Python code. Detailed information can be found here: https://metplus.readthedocs.io/en/latest/Contributors_Guide/coding_standards.html
METplus has adopted some coding standards for its Python code. Detailed information can be found in the `METplus Coding Standards <https://metplus.readthedocs.io/en/latest/Contributors_Guide/coding_standards.html>`_ documentation.

Comment the Python code using Python docstrings: https://peps.python.org/pep-0257/
Comment the Python code using `Python docstring conventions <https://peps.python.org/pep-0257/>`_.

Organization of Code in the Github Repository
=============================================
Expand Down

0 comments on commit a8f3ba6

Please sign in to comment.