Commit 435edfb
committed
docs(ofrep): separate the reason a tag is withheld from the notes beside it
Two capability omissions in this suite are argued in the javadoc, and Appendix F's
declaring rules have since drawn lines through both arguments.
@numeric-coercion is withheld because the provider does not coerce -- it
type-checks in both directions -- and no requirement says it must, which is the
question that comes first and settles this one. The paragraph that follows also
observed that declaring the tag would run a scenario the pinned testbed cannot
serve. That is now explicitly not a reason: a scenario failing for a missing
fixture is not a provider defect, so it argues for nothing. It stays as a note
about what such a run would look like, marked as one. The appendix's scenario-level
rule does not reach this omission either, and the javadoc says why rather than
leaving a reader to wonder: that rule is about whether a question is askable, and
all three of these are -- what it does not decide is whether an answer is owed.
@disabled-flags is the opposite case and the javadoc now says so plainly. The
provider receives the codeDefaultFlag response, parses its reason and answers with
the wrong error code, so it does attempt the behaviour, and the settled guidance
prefers declaring the tag and letting the four rows fail with this same deviation
beside them. That is a change of results rather than of prose and is not made
here; recording it is what stops it being lost.
Signed-off-by: Simon Schrottner <simon.schrottner@flagsmith.com>1 parent c5b4510 commit 435edfb
1 file changed
Lines changed: 26 additions & 2 deletions
Lines changed: 26 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
192 | 192 | | |
193 | 193 | | |
194 | 194 | | |
195 | | - | |
196 | | - | |
| 195 | + | |
| 196 | + | |
| 197 | + | |
| 198 | + | |
| 199 | + | |
| 200 | + | |
| 201 | + | |
| 202 | + | |
| 203 | + | |
| 204 | + | |
| 205 | + | |
| 206 | + | |
| 207 | + | |
197 | 208 | | |
198 | 209 | | |
199 | 210 | | |
| |||
292 | 303 | | |
293 | 304 | | |
294 | 305 | | |
| 306 | + | |
| 307 | + | |
| 308 | + | |
| 309 | + | |
| 310 | + | |
| 311 | + | |
| 312 | + | |
| 313 | + | |
| 314 | + | |
| 315 | + | |
| 316 | + | |
| 317 | + | |
| 318 | + | |
295 | 319 | | |
296 | 320 | | |
297 | 321 | | |
| |||
0 commit comments