If function X throws a checked exception (documenting it in its doc comment with @throws), then anything calling X should either catch the exception, or document it with @throws in its own doc comment.
Phan can check this using the warn_about_undocumented_exceptions_thrown_by_invoked_functions option, so this should be enabled in our config.
| Subject | Repo | Branch | Lines +/- | |
|---|---|---|---|---|
| Warn if a checked exception is not caught or re-documented | mediawiki/tools/phan | master | +2 -0 |
| Status | Subtype | Assigned | Task | ||
|---|---|---|---|---|---|
| Open | None | T321683 Formalize exception handling and annotations in MediaWiki and enforce it in CI | |||
| Open | Daimona | T338424 Enable phan rules to warn if a checked exception is not caught or documented |
Change 928523 had a related patch set uploaded (by Daimona Eaytoy; author: Daimona Eaytoy):
[mediawiki/tools/phan@master] Warn if a checked exception is not caught or re-documented