[BUG]: In the "First Steps", "Compiling the test cases" section of the documentation, there is no context as to where to run cmake.
Open
Nobody has claimed this yet.
docs
- Dominant language
- C++
- Stars
- 18k
- Forks
- 2.3k
- Avg merge
- 5d 17h
- Merged PRs (30d)
- 10
Description
Required prerequisites
- Make sure you've read the documentation. Your issue may be addressed there.
- Search the issue tracker and Discussions to verify that this hasn't already been reported. +1 or comment there if it has.
- Consider asking first in the Gitter chat room or in a Discussion.
Problem description
In the "First Steps", "Compiling the test cases" section of the documentation, there is no context as to where to run cmake. There is no context as to where the test cases are located. I installed via pip on macos.
Reproducible example code
location of pybind11:
python3 -m pip install pybind11
Requirement already satisfied: pybind11 in /Library/Frameworks/Python.framework/Versions/3.10/lib/python3.10/site-packages (2.9.2)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the documentation's “First Steps” section, specifically “Compiling the test cases,” and review the existing CMake instructions and pip-install context. Clarify where to run cmake and where the test cases are located, then verify that the instructions are understandable for a macOS pip installation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cmake, cpp, python
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100