docs: clarify where to run the "Compiling the test cases" commands - #6170
Open
zzbnb4396 wants to merge 1 commit into
Open
docs: clarify where to run the "Compiling the test cases" commands#6170zzbnb4396 wants to merge 1 commit into
zzbnb4396 wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
The First Steps page currently shows the "Compiling the test cases" commands
(
mkdir build && cd build && cmake .. && make check) right after telling newusers they can install pybind11 via
pip install, with no hint that thecommands are only meaningful from the root of a source checkout of the
pybind11 repository, nor that the pip wheels do not contain the bundled
tests.
This adds three sentences to
docs/basics.rstclarifying that:tests/directory,
pip install pybind11don't include those tests, sopip users should start from a git checkout instead (cross-linked to the
installing page).
Why
Closes #3871. The reporter followed the page after a pip install and there
was no context about where to run the commands or where the test cases live;
the maintainer's reply in the thread invited exactly this kind of wording
(e.g. "starting with a git checkout").
How verified
docutilsparse ofdocs/basics.rst: no structural errors, baseline vs.modified compared (only expected Sphinx-role noise).
git diff --check: clean.Suggested changelog entry:
Steps page must be run from the root of a source checkout of pybind11,
since pip wheels don't include the bundled test suite.
📚 Documentation preview 📚: https://pybind11--6170.org.readthedocs.build/