summaryrefslogtreecommitdiff
path: root/doc/source/reference/arrays.interface.rst
diff options
context:
space:
mode:
authorPauli Virtanen <pav@iki.fi>2009-03-08 17:12:48 +0000
committerPauli Virtanen <pav@iki.fi>2009-03-08 17:12:48 +0000
commitbb4c141e31484ecc2af21a26cf11d9293c3d7284 (patch)
tree5360a4530aba40cebe7c5d65cd214c1cb1d63bfa /doc/source/reference/arrays.interface.rst
parent8103f47751bbc86e9c0f9f67746a29b7c4099bf8 (diff)
downloadnumpy-bb4c141e31484ecc2af21a26cf11d9293c3d7284.tar.gz
doc: make the endorsement of PEP 3118 over the old array interface more strongly worder
Diffstat (limited to 'doc/source/reference/arrays.interface.rst')
-rw-r--r--doc/source/reference/arrays.interface.rst19
1 files changed, 13 insertions, 6 deletions
diff --git a/doc/source/reference/arrays.interface.rst b/doc/source/reference/arrays.interface.rst
index 62f146bc1..e17bb7dfc 100644
--- a/doc/source/reference/arrays.interface.rst
+++ b/doc/source/reference/arrays.interface.rst
@@ -8,6 +8,19 @@
The Array Interface
*******************
+.. warning::
+
+ This page describes the old, deprecated array interface. Everything still
+ works as described as of numpy 1.2 and on into the foreseeable future), but
+ new development should target :pep:`3118` --
+ :cfunc:`The Revised Buffer Protocol <PyObject_GetBuffer>`.
+ :pep:`3118` was incorporated into Python 2.6 and 3.0, and is additionally
+ supported by Cython's numpy buffer support. (See the Cython numpy
+ tutorial.) Cython provides a way to write code that supports the buffer
+ protocol with Python versions older than 2.6 because it has a
+ backward-compatible implementation utilizing the legacy array interface
+ described here.
+
:version: 3
The array interface (sometimes called array protocol) was created in
@@ -29,12 +42,6 @@ or it can be a quite arbitrary and complicated C-like structure.
There are two ways to use the interface: A Python side and a C-side.
Both are separate attributes.
-.. note::
-
- An alternative to the array interface;
- :cfunc:`The Revised Buffer Protocol <PyObject_GetBuffer>`, :pep:`3118`
- is introduced in Python 2.6.
-
Python side
===========