valkyrjaio / valkyrja-php / 32207847988
100%

DEFAULT BRANCH: 26.x
Ran
Jobs 1
Files 1189
Run time 2min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 100.0%. Remained the same
32207847988

push

github

web-flow 
[Comment] docs: Remove the prose from type and override doc blocks (#1219)

# Description

Golden rules 14 and 15 forbid prose on a type declaration and prose
added under an inherited doc block. A test fixture is the one exception,
and it carries a single line that says what the fixture is for. This
removes the blocks that break those rules.

`ChildContainer::getSingletonWithoutChecks` described its singleton
resolution order in the doc block: the child's own cached instance
first, then the parent's already-resolved instance, then a fresh
instance built from the local binding. A doc comment describes the
method, not one implementation of it, so every override would inherit a
description of this one. The method body already comments each step, so
the block returns to a bare `@inheritDoc`.

`WorkerHttpFixture::bootstrapParentServices` described itself as a no-op
that skips `CollectionContract` resolution. The body resolves
`RouteCollectionContract` and registers a route, so the description was
false, and a reader who trusted it would have been misled about what the
fixture does. The accurate half — that the counter lets a test assert
bootstrap runs once rather than once per request — moves into the body
beside the counter it explains.

`Component` and `Model` each carried a `Will be overridden if need be`
line indented under `@phpstan-consistent-constructor`. The annotation
stays; only the stray line goes.

The 25 fixture blocks kept their first sentence and dropped the rest.
The detail they carried described each fixture's individual method
overrides, which the methods themselves show.

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

The diff contains no executable change. PHPStan, PHP-CS-Fixer, and the
full suite of 5,654 tests all pass.

## Types of changes

- [ ] Improvement _(non-breaking change which improves code)_
- [ ] Bug fix _(non-breaking change... (continued)

12846 of 12846 relevant lines covered (100.0%)

25.92 hits per line

Jobs
ID Job ID Ran Files Coverage
1 32207847988.1 1189
100.0
 GitHub Action Run
Source Files on build 32207847988