REL: Prepare for 1.18 branch #15031
REL: Prepare for 1.18 branch #15031
Conversation
|
Is there a reason gh-14794 (ragged array deprecation) which is approved, is not going in? We need to encourage more reviewers to push the merge button. Also I think gh-15007 (C-API cleanup) should be part of the release, since it will be difficult to change the function names once we have officially released a version of the C-API. @rgommers, any thoughts? |
you're completely right. it was missing the 1.18.0 milestone, I'll add it now and will aim to review today |
|
LGTM, so in it goes. I'll add a couple of comments since @charris still plans to edit the release notes after merging. |
|
|
||
| Multivariate hypergeometric distribution added to `numpy.random` | ||
| ---------------------------------------------------------------- | ||
| The method `multivariate_hypergeometric` has been added to the class |
There was a problem hiding this comment.
This should be double backticks. Applies to anything in this file that's not numpy.submodule.this_is_a_fully_qualified_name_to_an_object.
| Deprecations | ||
| ============ | ||
|
|
||
| `np.fromfile` and `np.fromstring` will error on bad data |
There was a problem hiding this comment.
just to be sure: anything that's np. will be a broken link. needs either changing to numpy. or to double backticks
| will throw an error when parsing bad data. | ||
| This will now give a ``DeprecationWarning`` where previously partial or | ||
| even invalid data was silently returned. This deprecation also affects | ||
| the C defined functions c:func:`PyArray_FromString`` and |
There was a problem hiding this comment.
I'd much prefer double backticks over c:func:, because we're using these release notes in other places (like https://github.com/numpy/numpy/releases and in the Tidelift dashboard) where c:func: will just look weird.
There was a problem hiding this comment.
I've gone ahead and changed all the links to double backticks for consistency. If links are preferred the fix will not be difficult. I think we can now use np.* as well as numpy.*. @mattip?
There was a problem hiding this comment.
because we're using these release notes in other places (like https://github.com/numpy/numpy/releases
Perhaps we should enhance the pavement.py script to do more. I don't even see where it converts rst to markdown, but it is writing a file with a md suffix. @charris do you need to massage this by hand?
we can now use
np.*as well asnumpy.*
Unfortunately no, we have not worked out a way to do that. Here is a rendered release note from a PR, the np.* links are broken. I tried to fix that in gh-11344, but failed, maybe now that we have moved to sphinx 2.2.0 there is a way to support that
| (`gh-14393 <https://github.com/numpy/numpy/pull/14393>`__) | ||
|
|
||
|
|
||
| New Features |
There was a problem hiding this comment.
To split up "New functions" and "New features" is odd.
There was a problem hiding this comment.
Hmm, this is part of the basic template. We could change that.
| (`gh-14771 <https://github.com/numpy/numpy/pull/14771>`__) | ||
|
|
||
|
|
||
| Changes |
There was a problem hiding this comment.
"Changes" and "Compatibility notes" look like the same thing.
There was a problem hiding this comment.
This is also part to the template, could also be changed.
| (`gh-13794 <https://github.com/numpy/numpy/pull/13794>`__) | ||
|
|
||
|
|
||
| Deprecations |
There was a problem hiding this comment.
The order of headings is odd and inconsistent with previous release notes. Can this be ordering like we had it before?
There was a problem hiding this comment.
It is the same ordering when I check against the doc/source/release/template.rst, but that hasn't been revisited for some time.
This should go in quickly so I can make the branch. I was tempted to just push it before folks started adding release note fragments. The release notes need editing, but I will do that after the branch.
Next time I might just branch before generating the notes.