swh:1:snp:4e3e7077647a709f15b8c1b32ce7100175d0580b
Tip revision: 1bb217a077d6fa1d507f963a60da81adfd099d79 authored by Jean Kossaifi on 14 July 2017, 03:03:33 UTC
Merge pull request #7 from chubei/master
Merge pull request #7 from chubei/master
Tip revision: 1bb217a
documentation.rst
=============
Documentation
=============
Documentation is a crutial part of this library.
All functions and classes should come with useful docstrings. For these, we use the numpy style docstrings.
In particular, use single backticks for variable's names.
Double backticks are used for inline code. For blocks of code, use double
colons, leave a white line and indent said lines of code.