pybind / pybind/pybind11_mkdoc
Can #include'd files be missing?
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 44
- Forks
- 24
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 1
Description
My C++ code depends on an external library, so I add the flag -I${nlohmann_SOURCE_DIR}/include to ensure that #include can find the headers. Now #include doesn't really need to work for pybind11_mkdoc to do its job, and indeed, if I do not add the flag -I${EXTERNAL_SOURCE_DIR}/include, pybind11_mkdoc still runs successfully. However, I get the following error message
fatal error: 'nlohmann/json_fwd.hpp' file not found
at the line where this file is #included. Can we eliminate this error message and guarantee to the user that pybind11_mkdoc works even if included files can't be found, or should we require that all #includes succeed?
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
No files, tests, or entry points are named. First reproduce the missing-header diagnostic with and without the external include path, then trace pybind11_mkdoc's handling of #include directives. Done means choosing and documenting one supported behavior, with verification that the resulting diagnostic or successful run matches that decision.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp, python
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100