numpy / numpy/numpy

QUERY: editable install warning seems to contradict meson-python docs?

Open
#29,490 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
32.8k
Forks
12.8k
Avg merge
1d 7h
Merged PRs (30d)
197

Description

https://github.com/numpy/numpy/blob/bac0a8e844a6cf18335177e6203e0e8a92cddeca/doc/source/building/index.rst?plain=1#L506-L507 says

Headers ... may not be available from an editable install.

However, the meson-python Editable installs docs page linked just above says:

An editable install exposes at least all the files that would be available in a regular installation.

wouldn't exposing at least all files imply exposing all headers? If so, does one of these pages need correcting?

@rgommers maybe you can help clear this up?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with doc/source/building/index.rst at the cited lines and compare its editable-install wording with the linked meson-python Editable installs documentation. Determine whether NumPy headers are included in a regular installation and editable installation, then update the relevant documentation so the two statements are consistent.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.