8000 BUG: fix release snippet failures caught only after merging by mattip · Pull Request #14526 · numpy/numpy · GitHub
[go: up one dir, main page]

Skip to content

BUG: fix release snippet failures caught only after merging #14526

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

Merged
merged 2 commits into from
Sep 16, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions doc/release/upcoming_changes/14510.compatibility.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
`numpy.lib.recfunctions.drop_fields` can no longer return ``None``
------------------------------------------------------------------
`numpy.lib.recfunctions.drop_fields` can no longer return `None`
----------------------------------------------------------------
If ``drop_fields`` is used to drop all fields, previously the array would
be completely discarded and ``None`` returned. Now it returns an array of the
be completely discarded and `None` returned. Now it returns an array of the
same shape as the input, but with no fields. The old behavior can be retained
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was this note really broken?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The note was fine. The issue is that when the template consumes it, no blank line was added after the note. That meant the code block had no blank line after it, which sphinx RST doesn't like.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, I think I like the solution of just adding a bit of text under the fragment best. Feels a bit wrong that there is no better way, but if we like the autmatic addition of the link it is a bit tricky (unless we remove automatic whitespace stripping, but...). Did not realize None was fine with single quotes.

with::

dropped_arr = drop_fields(arr, ['a', 'b'])
if dropped_arr.dtype.names == ():
dropped_arr = None

converting the empty recarray to `None`
2 changes: 0 additions & 2 deletions numpy/distutils/misc_util.py
Original file line number Diff line number Diff line change
Expand Up @@ -1687,8 +1687,6 @@ def add_npy_pkg_config(self, template, install_dir, subst_dict=None):

and will be installed as foo.ini in the 'lib' subpath.

Cross-compilation
-----------------
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not a valid docstring section name

When cross-compiling with numpy distutils, it might be necessary to
use modified npy-pkg-config files. Using the default/generated files
will link with the host libraries (i.e. libnpymath.a). For
Expand Down
0