feat: first pass at improving documentation content #13
innocenzicoding-conventions.yml
on: pull_request
Run style check
16s
Annotations
2 errors and 5 warnings
|
Run style check
Process completed with exit code 1.
|
|
analysis/parameter-name:
src/Markdown/Alerts/AlertBlockRenderer.php#L14
Parameter name mismatch in overridden method 'App\Markdown\Alerts\AlertBlockRenderer::render'.
Changing parameter names in overridden methods can break code using named arguments.
Callers referencing parameters by name will encounter runtime errors if names differ.
Help: Rename parameter to `$childRenderer` to match the parent declaration in `League\CommonMark\Renderer\NodeRendererInterface::render`
|
|
strictness/require-return-type:
src/Markdown/Alerts/AlertBlockRenderer.php#L13
Method `render` is missing a return type hint.
Type hints improve code readability and help prevent type-related errors.
Help: Consider adding a return type hint to method `render`.
|
|
strictness/require-return-type:
src/Markdown/CodeBlockRenderer.php#L22
Method `render` is missing a return type hint.
Type hints improve code readability and help prevent type-related errors.
Help: Consider adding a return type hint to method `render`.
|
|
strictness/require-property-type:
src/Markdown/Alerts/AlertBlockParser.php#L14
Property `$finished` is missing a type hint.
Adding a type hint to properties improves code readability and helps prevent type errors.
Help: Consider specifying a type hint for `$finished`.
|
|
strictness/require-property-type:
src/Markdown/Alerts/AlertBlockParser.php#L13
Property `$block` is missing a type hint.
Adding a type hint to properties improves code readability and helps prevent type errors.
Help: Consider specifying a type hint for `$block`.
|
|
comment/no-untagged-todo:
src/Web/Documentation/ChapterView.php#L38
TODO should be tagged with (@username) or (#issue).
Help: Add a user tag or issue reference to the TODO comment, e.g. TODO(@azjezz), TODO(azjezz), TODO(#123).
|