valkyrjaio / sindri-java / 32207996101

100%

push

github

[Fixture] docs: Reduce each fixture doc block to the one allowed line (#139)

# Description

Golden rule 15 gives a test fixture one line on the declaration, which
says what the fixture is for. Two test-resource fixtures carried more.

`TestNonLiteralGrpcControllerFixture` kept the sentence naming what
makes it non-literal and dropped the clause restating that Sindri cannot
resolve it, which is the point of the test that uses it.
`FrameworkComponentProvider` kept the sentence placing it outside the
app namespace and dropped the detail about the fallback it exercises and
the nesting it proves, both of which its own members and its test show.

This is a partial pass. The readers and the exceptions under `src` stay
for now, because each carries a fact the declaration cannot show — which
stage contracts a middleware class implements, or why a write failure
must not pass silently. Rule 15 moves that material to the component
documentation rather than deleting it, so those blocks need the
documentation written first.

Test classes are out of scope. Rule 15 names a test fixture as the
exception and says nothing about a test class.

The diff contains no executable change. Spotless passes and the JUnit
build passes.

## Types of changes

- [ ] Improvement _(non-breaking change which improves code)_
- [ ] Bug fix _(non-breaking change which fixes an issue)_
- [ ] New feature _(non-breaking change which adds functionality)_
- [ ] Deprecation _(breaking change which removes functionality)_
- [ ] Breaking change _(fix or feature that would cause existing
functionality to change)_
- [x] Documentation improvement

## Changes

- **`TestNonLiteralGrpcControllerFixture.java`**,
**`FrameworkComponentProvider.java`** — reduced each declaration block
to the one line rule 15 allows

618 of 618 branches covered (100.0%)

Branch coverage included in aggregate %.

1679 of 1679 relevant lines covered (100.0%)

4.39 hits per line