valkyrjaio / sindri-php / 32207875234
100%

DEFAULT BRANCH: 26.x
Ran
Jobs 1
Files 79
Run time 1min
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
32207875234

push

github

web-flow 
[Comment] docs: Remove the restating doc blocks from type declarations (#275)

# Description

Golden rule 15 forbids a doc comment on a type declaration, because the
name and the segment already say what the type is. 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 that rule and add nothing.

Seven contracts under `Ast\Data\Contract` each carried one sentence of
the form "Contract for a portable X intermediate representation", where
X was the class name written out. The namespace already says `Data` and
`Contract`, and the name already says which data. The sentence therefore
stated nothing the declaration does not.

The three provider fixtures kept their first sentence. The second
sentence named the branch each fixture exercises, which the test that
uses the fixture shows.

This is a partial pass. The blocks that carry a fact the declaration
cannot show — the readers under `Ast`, the generators under
`Generator\Ast`, and `HandlerDataContract` — stay for now. 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, so `BinBootTest` and
`GoldenSnapshotTest` are unchanged.

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

## 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

- **`Ast/Data/Contract/`** — removed the declaration doc block from
`CliArgumentParameterDataCont... (continued)

1554 of 1554 relevant lines covered (100.0%)

17.53 hits per line

Jobs
ID Job ID Ran Files Coverage
1 32207875234.1 79
100.0
 GitHub Action Run
Source Files on build 32207875234