diff options
author | Travis E. Oliphant <teoliphant@gmail.com> | 2012-07-17 15:03:05 -0500 |
---|---|---|
committer | Travis E. Oliphant <teoliphant@gmail.com> | 2012-07-17 15:03:05 -0500 |
commit | b8a2ea7d5416775e71266167bad3e02b292316dc (patch) | |
tree | 0e85ff51b0b47d6ab1149c2f1fe9778a120c3548 /doc | |
parent | 93e42ddff0005b51fcecbc6731ab8cbd268e6e6b (diff) | |
download | numpy-b8a2ea7d5416775e71266167bad3e02b292316dc.tar.gz |
DOC: Update API description with suggestions from charris.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/source/reference/c-api.deprecations.rst | 13 |
1 files changed, 5 insertions, 8 deletions
diff --git a/doc/source/reference/c-api.deprecations.rst b/doc/source/reference/c-api.deprecations.rst index fead417eb..a7960648a 100644 --- a/doc/source/reference/c-api.deprecations.rst +++ b/doc/source/reference/c-api.deprecations.rst @@ -13,20 +13,17 @@ desire to make it easy for users to move to NumPy from Numeric and Numarray. The core API originated with Numeric in 1995 and there are patterns such as the heavy use of macros written to mimic Python's C-API as well as account for compiler technology of the late 90's. -There is only a small group of volunteers who have had very little +There is also only a small group of volunteers who have had very little time to spend on improving this API. -Despite these constraints, there is an ongoing effort to improve the -API to do things like remove -stray macros (e.g. a "fortran" macro) and ensure that the NPY_ prefixes -don't prepend names that collide with -names from the PyArray_ prefixes. It is important in this effort +There is an ongoing effort to improve the API. +It is important in this effort to ensure that code that compiles for NumPy 1.X continues to -compile for NumPy 1.X. At the same time certain API's will be marked +compile for NumPy 1.X. At the same time, certain API's will be marked as deprecated so that future-looking code can avoid these API's and follow better practices. -Another important role played by deprecations in the C API is to move +Another important role played by deprecation markings in the C API is to move towards hiding internal details of the NumPy implementation. For those needing direct, easy, access to the data of ndarrays, this will not remove this ability. Rather, there are many potential performance |