fix: render fix in config.sample#41632
Conversation
|
Thanks for opening this pull request! The maintainers of this repository would appreciate it if you would create a changelog item based on your changes. |
|
The linter complaint is wrong. There has to be this kind of blank line, otherwise rendering is incorrect... |
You added a trailing whitespace which is not allowed. please fix. thank you |
DeepDiver1975
left a comment
There was a problem hiding this comment.
🤖 Automated review by Claude Code review agent.
Overview
This PR adds a single blank PHPDoc comment line (*) before the "Available failover modes" bullet list in config/config.sample.php. The intent (per the description) is to fix list rendering in the generated config docs: without a blank separator line, the downstream doc generator collapses the list items onto a single line instead of rendering them as a proper bullet list.
Code quality / style
- The change is minimal, focused, and low-risk: it touches only a comment block, not executable configuration. No PHP behavior is affected.
- The added line follows the existing PHPDoc comment style of the surrounding block (
*leading the line).
Specific suggestions
- Minor: the new line was committed as
*with a trailing space. The repo's coding standard (and most linters) flag trailing whitespace. Prefer a bare*with no trailing space to avoid tripping whitespace checks. This is the only nit and is non-blocking. - For consistency, it's worth confirming other similar bullet lists in this file (e.g. other "Available ..." enumerations) already have the same blank-line separator, so the rendering treatment is uniform across
config.sample.php.
Potential issues / risks
- None functional.
config.sample.phpis documentation/template only; adding a comment line cannot change runtime config parsing. - The real validation is the rendered output, which can only be confirmed by the post-merge config-to-docs run the author mentions. The source change itself is correct for producing a blank line in the doc source, which is the standard way to force AsciiDoc/Markdown list rendering.
LGTM aside from the trailing-whitespace nit.
6b5ac43 to
fa5530f
Compare
This is small render fix for config.sample.
With this, the list it will render as such (otherwise things get rendered in one line and not as list)
Post merging, I will do a config-to-docs run and add the change to the current docs-server PR of OC11