phpDocumentor / phpDocumentor/guides
[Bug]: Included files show errors and warnings at the include location
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 36
- Forks
- 22
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 24
Description
Summary
When you include a file that has a warning, it will give you no real hint on where the problem lies:
Code snippet that reproduces the problem
Page Types/Index includes several rst files. one of them has a warning
Output:
[2024-09-07T07:43:19.947049+00:00] app.WARNING: Reference subtypes-excludelist could not be resolved in Types/Index {"rst-file":"Types/Index"} []
Expected output
[2024-09-07T07:43:19.947049+00:00] app.WARNING: Reference subtypes-excludelist could not be resolved in Types/Index {"rst-include":"Types/_Properties/XYZ"} ['line':42 ]
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
Reproduce the warning from the included RST file example and trace how the parser reports diagnostics for included files. The fix is done when warnings identify the included RST path and line, matching the expected output shown in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100