<commit_before>====================================
A Guide to NumPy/SciPy Documentation
====================================

.. Contents::

Overview
--------
In general, we follow the standard Python style conventions as described here:
 * `Style Guide for C Code <http://www.python.org/peps/pep-0007.html>`__
 * `Style Guide for Python Code <http://www.python.org/peps/pep-0008.html>`__
 * `Docstring Conventions <http://www.python.org/peps/pep-0257.html>`__

Additional PEPs of interest regarding documentation of code:
 * `Docstring Processing Framework <http://www.python.org/peps/pep-0256.html>`__
 * `Docutils Design Specification <http://www.python.org/peps/pep-0258.html>`__

Use a code checker:
 * `pylint <http://www.logilab.org/857>`__
 * `pep8.py <http://svn.browsershots.org/trunk/devtools/pep8/pep8.py>`__

Common import standards:
 * import numpy as np
 * import scipy as sp
<commit_msg>formatting<commit_after>====================================
A Guide to NumPy/SciPy Documentation
====================================

.. Contents::

Overview
--------
In general, we follow the standard Python style conventions as described here:
 * `Style Guide for C Code <http://www.python.org/peps/pep-0007.html>`__
 * `Style Guide for Python Code <http://www.python.org/peps/pep-0008.html>`__
 * `Docstring Conventions <http://www.python.org/peps/pep-0257.html>`__

Additional PEPs of interest regarding documentation of code:
 * `Docstring Processing Framework <http://www.python.org/peps/pep-0256.html>`__
 * `Docutils Design Specification <http://www.python.org/peps/pep-0258.html>`__

Use a code checker:
 * `pylint <http://www.logilab.org/857>`__
 * `pep8.py <http://svn.browsershots.org/trunk/devtools/pep8/pep8.py>`__

Common import standards::

   import numpy as np
   import scipy as sp

{'fraction_non_alphanumeric': 0.2119535141117875, 'fraction_numerical': 0.02877697841726619, 'mean_word_length': 4.512195121951219, 'pattern_counts': {'":': 0, '<': 17, '<?xml version=': 0, '>': 17, 'https://': 0, 'lorem ipsum': 0, 'www.': 12, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5081836', 'n_tokens_mistral': 643, 'n_tokens_neox': 581, 'n_words': 140}