From 994b260095bbe44ce8a4fbd79ae722471ac63ca8 Mon Sep 17 00:00:00 2001
From: Andreas Kloeckner <inform@tiker.net>
Date: Wed, 24 Feb 2016 18:42:44 -0600
Subject: [PATCH] Improve split_iname docs
---
loopy/transform/iname.py | 17 +++++++++++++++--
1 file changed, 15 insertions(+), 2 deletions(-)
diff --git a/loopy/transform/iname.py b/loopy/transform/iname.py
index 728934915..545f4b1b2 100644
--- a/loopy/transform/iname.py
+++ b/loopy/transform/iname.py
@@ -282,8 +282,21 @@ def split_iname(kernel, split_iname, inner_length,
within=None):
"""Split *split_iname* into two inames (an 'inner' one and an 'outer' one)
so that ``split_iname == inner + outer*inner_length`` and *inner* is of
- fixed length *inner_length*.
-
+ constant length *inner_length*.
+
+ :arg outer_iname: The new iname to use for the 'inner' (fixed-length)
+ loop. Defaults to a name derived from ``split_iname + "_outer"``
+ :arg inner_iname: The new iname to use for the 'inner' (fixed-length)
+ loop. Defaults to a name derived from ``split_iname + "_inner"``
+ :arg inner_length: a positive integer
+ :arg slabs:
+ A tuple ``(head_it_count, tail_it_count)`` indicating the
+ number of leading/trailing iterations of *outer_iname*
+ for which separate code should be generated.
+ :arg outer_tag: The iname tag (see :ref:`iname-tag`) to apply to
+ *outer_iname*.
+ :arg inner_tag: The iname tag (see :ref:`iname-tag`) to apply to
+ *inner_iname*.
:arg within: a stack match as understood by
:func:`loopy.context_matching.parse_stack_match`.
"""
--
GitLab