Review finding 17/19 · conventional-comment issue (test) · area binder · gate: follow-up
To add once they exist: labels binder, test. (Already applied: bug.)
Problem
The FirstClassErrors package's FCExxx analyzers validate error-documentation wiring ([DocumentedBy] references resolve, factories are documented, examples call the documented factory, codes are unique). The RequestBinder project references FirstClassErrors via ProjectReference, which does not bring the bundled analyzers, so RequestBindingError's documentation is not analyzer-checked.
Impact
The binder authored [ProvidesErrorsFor] / [DocumentedBy] error documentation, but a future break in that wiring would not be caught at compile time as it is everywhere else in the repo.
Direction
Wire the analyzers into the binder project so its error documentation is enforced like the rest of the library.
Context
Surfaced by the RequestBinder review (design spec #126, shipped in #141). Finding 17 of 19.
Note: the binder's documentation is currently exercised by BindingContractTests (reflection), but not by the analyzers.
Problem
The
FirstClassErrorspackage'sFCExxxanalyzers validate error-documentation wiring ([DocumentedBy]references resolve, factories are documented, examples call the documented factory, codes are unique). The RequestBinder project referencesFirstClassErrorsviaProjectReference, which does not bring the bundled analyzers, soRequestBindingError's documentation is not analyzer-checked.Impact
The binder authored
[ProvidesErrorsFor]/[DocumentedBy]error documentation, but a future break in that wiring would not be caught at compile time as it is everywhere else in the repo.Direction
Wire the analyzers into the binder project so its error documentation is enforced like the rest of the library.
Context
Surfaced by the RequestBinder review (design spec #126, shipped in #141). Finding 17 of 19.
Note: the binder's documentation is currently exercised by
BindingContractTests(reflection), but not by the analyzers.