Raw File
Tip revision: f7e7962ff272df751da09e08d16cf9978bc37e01 authored by Jean Kossaifi on 03 December 2016, 23:53:35 UTC
Updated version
Tip revision: f7e7962

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.
back to top