valkyrjaio / valkyrja-java / 30749183361

100%

push

github

[Provider] docs: Split the run-on sentence in the ComponentProviderContract javadoc (#123)

# Description

The review of valkyrjaio/valkyrja-java#122 found one sentence in the
`ComponentProviderContract`
javadoc that breaks the documentation style. #122 merged before the fix
landed, so this pull
request carries it as a follow-up.

The sentence joined two ideas with "and" and ran to 32 words. Section 8
of the cross-language guide
caps a description at 25 words and asks for one idea per sentence.

Before:

```java
 * inherited default is not a method on the component, so no test asserts it, and a component that
 * must supply a provider can return empty with nothing to report the fault.
```

After:

```java
 * inherited default is not a method on the component, so no test asserts it. A component that must
 * supply a provider can then return empty, and nothing reports the fault.
```

The two sentences are 15 words and 17 words. Each one states one idea.

This change touches prose only. No code, no signature, and no test
changes. The full CI gate 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

- **`application/provider/contract/ComponentProviderContract.java`** —
split the second sentence of
  the warning paragraph in the type-level javadoc into two sentences.

1929 of 1929 branches covered (100.0%)

Branch coverage included in aggregate %.

7070 of 7070 relevant lines covered (100.0%)

4.33 hits per line