Skip to content

Conversation

@dnicolodi
Copy link
Member

Replaces #786.

@dnicolodi dnicolodi force-pushed the docs-editable-data branch 4 times, most recently from 3bc90fe to 2816ac6 Compare October 25, 2025 21:08
@rgommers rgommers added the documentation Improvements or additions to documentation label Oct 26, 2025
Copy link
Contributor

@rgommers rgommers left a comment

Choose a reason for hiding this comment

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

Thanks @dnicolodi. The added text about how to use data files LGTM (modulo the minor open comments) and is useful.

It doesn't quite address the "can't use the NumPy C API from another package when NumPy itself is installed in editable mode". It can be added to this PR, probably as a .. warning:: note at the end, or left for a separate follow-up.

@dnicolodi dnicolodi force-pushed the docs-editable-data branch 8 times, most recently from 469c4f5 to 1bac81f Compare October 26, 2025 18:01
@dnicolodi
Copy link
Member Author

It doesn't quite address the "can't use the NumPy C API from another package when NumPy itself is installed in editable mode". It can be added to this PR, probably as a .. warning:: note at the end, or left for a separate follow-up.

I feel that the numPy issue is too specific to be mentioned in the general documentation for editable installs. I think that the documentation now states clearly the reason why the headers cannot be used. Anything more specific would be more discoverable in the NumPy documentation or in a new "Papercuts" section of the documentation (maybe started by renaming the current "Limitations" section).

@rgommers
Copy link
Contributor

Anything more specific would be more discoverable in the NumPy documentation or in a new "Papercuts" section of the documentation (maybe started by renaming the current "Limitations" section).

Fair enough. And I like the Papercuts name. I can have a look at it, also seeing if/where it needs a warning in the NumPy docs.

@rgommers
Copy link
Contributor

rgommers commented Oct 26, 2025 via email

@dnicolodi
Copy link
Member Author

I'll keep the note about the issue with importlibn.resources in Python 3.9 in the .. warning directive because I like it more there.

@rgommers
Copy link
Contributor

I can have a look at it, also seeing if/where it needs a warning in the NumPy docs.

The NumPy docs at https://numpy.org/devdocs/building/index.html have this warning at the bottom of the section on editable installs, so that part should be covered:

image

Copy link
Contributor

@rgommers rgommers left a comment

Choose a reason for hiding this comment

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

LGTM now, and the added test is also nice. In it goes.

@rgommers rgommers merged commit 62d4f8b into mesonbuild:main Oct 28, 2025
43 checks passed
@rgommers rgommers added this to the v0.19.0 milestone Oct 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants