From 4993d7e131e7988eb51b82ab496b6f0060ebfe63 Mon Sep 17 00:00:00 2001 From: Jukka Aho Date: Sun, 5 Jul 2015 22:11:22 +0300 Subject: [PATCH] updated docstyle guidelines --- CONTRIBUTING.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a781884..d75b228 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -46,3 +46,8 @@ Code indentation ---------------- We use 4 spaces like in Python. [See issue #5](https://github.com/JuliaFEM/JuliaFEM.jl/issues/5) +Function docstrings +------------------- +We use numpy documentation style in our functions. See https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt. See issue #5. + +