valkyrjaio / valkyrja-starter-app-php / 32207896841
100%

DEFAULT BRANCH: 26.x
Ran
Jobs 1
Files 33
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
32207896841

push

github

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

# Description

Golden rule 14 says a doc comment describes the method, not one
implementation of it, because every override inherits the comment. Three
override blocks in the sample application added prose to an inherited
block.

`OpenSwooleApp::getSwooleServer` explained that the host and the port
come from the environment so a caller can bind a chosen address. The
reason the code cannot show — that a caller chooses the address — moves
into the body, which rule 14 permits. The example it gave, a free port
during an end-to-end test, is one caller's use rather than a property of
the method.

`SimpleModel::internalGetCallables` and
`SimpleModel::internalSetCallables` each opened with a sentence that
restated what the inherited contract already states. The inherited block
now stands alone.

The diff contains no executable change. PHP-CS-Fixer 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

- **`OpenSwooleApp.php`** — removed the paragraph from the `@inheritDoc`
block and kept the reason as a body comment
- **`SimpleModel.php`** — removed the restating sentence from two
`@inheritDoc` blocks

517 of 517 relevant lines covered (100.0%)

2.12 hits per line

Jobs
ID Job ID Ran Files Coverage
1 32207896841.1 33
100.0
 GitHub Action Run
Source Files on build 32207896841