From f5bf1dd3b962514c269a1a653cdd2c1d1be38b26 Mon Sep 17 00:00:00 2001 From: Juan Nunez-Iglesias Date: Tue, 30 Jun 2015 22:49:21 +1000 Subject: [PATCH] Point contributors to coordinate conventions --- CONTRIBUTING.txt | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CONTRIBUTING.txt b/CONTRIBUTING.txt index 9b1df551..fc62ea01 100644 --- a/CONTRIBUTING.txt +++ b/CONTRIBUTING.txt @@ -152,6 +152,10 @@ Stylistic Guidelines * When documenting array parameters, use ``image : (M, N) ndarray`` and then refer to ``M`` and ``N`` in the docstring, if necessary. +* Refer to array dimensions as (plane), row, column, not as x, y, z. See + `Coordinate conventions `__ + in the user guide for more information. + * Functions should support all input image dtypes. Use utility functions such as ``img_as_float`` to help convert to an appropriate type. The output format can be whatever is most efficient. This allows us to string together