more visibly mark for-from loop as deprecated in the docs

--HG--
extra : rebase_source : 305a362b2f79e4b7982a188ff5912a6621ea56a7

diff --git a/docs/src/reference/language_basics.rst b/docs/src/reference/language_basics.rst
index 6c6e1d1..7dece41 100644 (file)
--- a/docs/src/reference/language_basics.rst
+++ b/docs/src/reference/language_basics.rst
@@ -480,24 +480,31 @@ Operator Precedence
 For-loops
 ==========
 
-* ``range()`` is C optimized when the index value has been declared by ``cdef``::
+The "for ... in iterable" loop works as in Python, but is even more versatile
+in Cython as it can additionally be used on C types.
 
-    cdef i
+* ``range()`` is C optimized when the index value has been declared by ``cdef``,
+  for example::
+
+    cdef size_t i
     for i in range(n):
         ...
 
-* Iteration over C arrays is also permitted, e.g.::
+* Iteration over C arrays and sliced pointers is supported and automatically
+  infers the type of the loop variable, e.g.::
 
-    cdef double x
-    cdef double* data
+    cdef double* data = ...
     for x in data[:10]:
         ...
 
 * Iterating over many builtin types such as lists and tuples is optimized.
 
-* There is also a more C-style for-from syntax
+* There is also a more verbose C-style for-from syntax which, however, is
+  deprecated in favour of the normal Python "for ... in range()" loop.  You
+  might still find it in legacy code that was written for Pyrex, though.
+
+ * The target expression must be a plain variable name.
 
- * The target expression must be a variable name.
  * The name between the lower and upper bounds must be the same as the target name.
 
     for i from 0 <= i < n:
@@ -513,9 +520,11 @@ For-loops
     for i from n > i >= 0:
         ...
 
-* The ``break`` and ``continue`` are permissible.
+* The ``break`` and ``continue`` statements are permissible.
+
 * Can contain an else clause.
 
+
 =====================
 Functions and Methods
 =====================

diff --git a/docs/src/userguide/language_basics.rst b/docs/src/userguide/language_basics.rst
index 06a324b..dd2308d 100644 (file)
--- a/docs/src/userguide/language_basics.rst
+++ b/docs/src/userguide/language_basics.rst
@@ -465,8 +465,8 @@ the loop is not being converted correctly, use the annotate feature of
 the cython commandline (``-a``) to easily see the generated C code.
 See :ref:`automatic-range-conversion`
 
-For backwards compatibility to Pyrex, Cython also supports another
-form of for-loop::
+For backwards compatibility to Pyrex, Cython also supports a more verbose
+form of for-loop which you might find in legacy code::
 
     for i from 0 <= i < n:
         ...
@@ -478,9 +478,12 @@ or::
 
 where ``s`` is some integer step size.
 
+.. note:: This syntax is deprecated and should not be used in new code.
+          Use the normal Python for-loop instead.
+
 Some things to note about the for-from loop:
 
-* The target expression must be a variable name.
+* The target expression must be a plain variable name.
 * The name between the lower and upper bounds must be the same as the target
   name.
 * The direction of iteration is determined by the relations. If they are both