From 8388822624e8d1e3d915ef1798c3f02040e5d2a9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andreas=20Kl=C3=B6ckner?= Date: Thu, 14 Feb 2019 20:23:31 +0100 Subject: [PATCH] Improve arange docs --- pyopencl/array.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/pyopencl/array.py b/pyopencl/array.py index 1bfdc137..24c6ded6 100644 --- a/pyopencl/array.py +++ b/pyopencl/array.py @@ -2002,15 +2002,16 @@ def _arange_knl(result, start, step): def arange(queue, *args, **kwargs): - """Create a :class:`Array` filled with numbers spaced `step` apart, - starting from `start` and ending at `stop`. + """arange(queue, [start, ] stop [, step], **kwargs) + Create a :class:`Array` filled with numbers spaced `step` apart, + starting from `start` and ending at `stop`. If not given, *start* + defaults to 0, *step* defaults to 1. For floating point arguments, the length of the result is `ceil((stop - start)/step)`. This rule may result in the last element of the result being greater than `stop`. - *dtype*, if not specified, is taken as the largest common type - of *start*, *stop* and *step*. + *dtype* is a required keyword argument. .. versionchanged:: 2011.1 *context* argument was deprecated. -- GitLab