Document that PhanCommentOverrideOnNonOverrideMethod and other issues depend on analyze_signature_compatibility
Open
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 5.6k
- Forks
- 365
- Avg merge
- 1h 25m
- Merged PRs (30d)
- 6
Description
(that issue and method signature compatibility issues won't be emitted if that is disabled in .phan/config.php)
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 describing PhanCommentOverrideOnNonOverrideMethod and method signature compatibility, and check the .phan/config.php setting for analyze_signature_compatibility. Document that these issues are not emitted when the setting is disabled, then verify the wording matches the configuration behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100