File tree Expand file tree Collapse file tree 1 file changed +8
-4
lines changed
docs/source/contributing/docs Expand file tree Collapse file tree 1 file changed +8
-4
lines changed Original file line number Diff line number Diff line change @@ -58,10 +58,14 @@ same happens with :class:`~.Point2D`, :class:`~.Point2D_Array` and
5858
5959The rule for typing functions is: **make parameter types as broad as possible,
6060and return types as specific as possible. ** Therefore, for functions which are
61- intended to be called by users, we should always, if possible, accept ``Like ``
62- types as parameters and return NumPy, non-``Like `` types. The last function,
63- ``shift_point_up() ``, is an example of it. Internal functions which are *not *
64- meant to be called by users may accept non-``Like `` parameters if necessary.
61+ intended to be called by users, **we should always, if possible, accept ``Like``
62+ types as parameters and return NumPy, non-``Like`` types. ** The main reason is to
63+ be more flexible with users who might want to pass tuples or lists as arguments
64+ rather than NumPy arrays, because it's more convenient. The last function,
65+ ``shift_point_up() ``, is an example of it.
66+
67+ Internal functions which are *not * meant to be called by users may accept
68+ non-``Like `` parameters if necessary.
6569
6670Vectors
6771~~~~~~~
You can’t perform that action at this time.
0 commit comments