From e1afe7e65a1c84911f8322a311fa33433b75215f Mon Sep 17 00:00:00 2001 From: Juan Nunez-Iglesias Date: Tue, 30 Jun 2015 22:49:48 +1000 Subject: [PATCH] Ask contributors to wrap Cython functions in Python --- CONTRIBUTING.txt | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CONTRIBUTING.txt b/CONTRIBUTING.txt index fc62ea01..3f0eed9c 100644 --- a/CONTRIBUTING.txt +++ b/CONTRIBUTING.txt @@ -166,6 +166,10 @@ Stylistic Guidelines * Use ``Py_ssize_t`` as data type for all indexing, shape and size variables in C/C++ and Cython code. +* Wrap Cython code in a pure Python function, which defines the API. This + improves compatibility with code introspection tools, which are often not + aware of Cython code. + Test coverage -------------