-
-
Notifications
You must be signed in to change notification settings - Fork 10.8k
DOC: Update 1.14 notes #10159
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DOC: Update 1.14 notes #10159
Conversation
ad33d2f
to
d85b459
Compare
doc/release/1.14.0-notes.rst
Outdated
@@ -342,6 +364,23 @@ This new default changes the float output relative to numpy 1.13. The old | |||
behavior can be obtained in 1.13 "legacy" printing mode, see compatibility | |||
notes above. | |||
|
|||
''hermitiean`` option added to``np.linalg.matrix_rank`` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo
doc/release/1.14.0-notes.rst
Outdated
computing dtype equality. For example, with the dtypes :: | ||
|
||
`x = dtype({'names': ['A', 'B'], 'formats': ['i4', 'f4'], 'offsets': [0, 4]})` | ||
`y = dtype({'names': ['B', 'A'], 'formats': ['f4', 'i4'], 'offsets': [4, 0]})` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Backticks no longer needed?
doc/release/1.14.0-notes.rst
Outdated
them more clear:: | ||
|
||
>>> np.polynomial.Polynomial(range(4)) | ||
Polynomial([ 0., 1., 2., 3.], domain=[-1, 1], window=[-1, 1]) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This needs updating with the new repr
Did PR ( #5580 ) get added to the changelog? |
@jakirkham The changelog is script generated before the release. It will be in the |
Sure. Didn't know if it needed further mention since it changes behavior. |
@jakirkham It does probably need a release note. If you post an entry here I'll put it in, probably under |
doc/release/1.14.0-notes.rst
Outdated
|
||
* Calling ``np.fromstring`` with the default value of the ``sep`` argument is | ||
deprecated. When that argument is not provided, a broken version of | ||
`np.frombuffer` is used that silently accepts unicode strings and -- after |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
double rather than single backticks for np.frombuffer
doc/release/1.14.0-notes.rst
Outdated
@@ -342,6 +364,28 @@ This new default changes the float output relative to numpy 1.13. The old | |||
behavior can be obtained in 1.13 "legacy" printing mode, see compatibility | |||
notes above. | |||
|
|||
''hermitian`` option added to``np.linalg.matrix_rank`` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
incorrect ticks instead of backticks here
doc/release/1.14.0-notes.rst
Outdated
Support for PGI flang compiler on Windows | ||
----------------------------------------- | ||
The PGI flang compiler is a Fortran front end for LLVM released by NVIDIA under | ||
the Apache 2 license. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would be good to add the magic incantation here, something like (did not check, just an example):
python setup.py config --compiler=clang --fcompiler=flang install
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Or links to another doc that gives this command
@jakirkham I added an entry for #5580. |
Thanks @charris. |
doc/release/1.14.0-notes.rst
Outdated
lines. If there is more than 1 dimension, the array attributes are now | ||
printed in a new "left-justified" printing style. | ||
* ``NaT`` values in datetime arrays are now properly aligned. | ||
* Arrays and scalars of ``np.void`` datatype are now print using hex notation. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
could we remove "are" here? or print -> printed.
doc/release/1.14.0-notes.rst
Outdated
@@ -248,7 +282,8 @@ C API changes | |||
--------------------------------------------------------------------- | |||
|
|||
The ``UPDATEIFCOPY`` flag is deprecated, and replaced by a new flag | |||
``WRITEBACKIFCOPY``. Use of the flag requires a call to ``PyArray_ResolveWritebackIfCopy``. | |||
``WRITEBACKIFCOPY``. Use of the flag requires a call to | |||
``PyArray_ResolveWritebackIfCopy``. | |||
|
|||
Code using ``UPDATEIFCOPY`` must be updated to account for changed semantics, as | |||
follows:. When ndarrays are created with either the deprecated ``UPDATEIFCOPY`` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
remove period after :
@mattip The |
@mattip Just to be sure, the way I would like things to be for 1.14 (and later) is that nobody will notice the updateifcopy work unless they specifically intend to support PyPy. I don't want downstream projects to need concern themselves otherwise. So for this work I think deprecate is too strong a word. To go along with that, I think the documentation in |
I am working on a documentation pull request. Currently (on master) calling |
Using the I am not sure I understood what you meant. |
@mattip The basic policy is that we cannot break the C-API, that is, extension modules compiled against earlier versions of Numpy should still work. Now there are a few api functions that are deprecated because of changes to the python api, mostly due to the transition to 64 bits, but those c-api functions are still there after all this time, they just call the newer functions internally. The current changes are a bit iffier, as they are only needed for PyPy compatibility (sorry ;), so I would actually prefer a whole new iterator rather than changing the behavior of the old one. I suspect that there is a lot of code that could be used by both the old and new iterators with small modifications. I am not familiar enough with the current state of things to make specific suggestions, so am just trying so set out the general philosophy. Perhaps this needs some more discussion, or maybe I just need some instruction. @eric-wieser, @ahaldane, @pv, @njsmith Thoughts? |
|
Well, I don't know, that's what I am trying to find out :) I Found the documentation in the release notes somewhat confusing, so what I have now (not committed) is
|
Alternate wording for the release notes, pending a decision on deprecation/non-deprecation:
|
I think the tutorial parts of the alternative belong elsewhere. Release notes are "what" and maybe some "why", but not so much "how" ;) |
|
but I should stop now, documentation is not my forte |
860fff7
to
c618b57
Compare
That release was not documented in the master branch. [ci skip]
[ci skip]
1f3570a
to
14913ed
Compare
Also forward ports the 1.13.3 release notes and changelog. I suggest viewing the notes as a rendered file as there are a number of rearrangements that clutter up the diff.