Skip to content

fix: render fix in config.sample#41632

Merged
DeepDiver1975 merged 1 commit into
masterfrom
render_fix_in_config_sample
Jun 17, 2026
Merged

fix: render fix in config.sample#41632
DeepDiver1975 merged 1 commit into
masterfrom
render_fix_in_config_sample

Conversation

@mmattel

@mmattel mmattel commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

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

@update-docs

update-docs Bot commented Jun 16, 2026

Copy link
Copy Markdown

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.

@mmattel

mmattel commented Jun 16, 2026

Copy link
Copy Markdown
Contributor Author

The linter complaint is wrong. There has to be this kind of blank line, otherwise rendering is incorrect...

@DeepDiver1975

Copy link
Copy Markdown
Member

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 DeepDiver1975 marked this pull request as draft June 16, 2026 21:09

@DeepDiver1975 DeepDiver1975 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 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.php is 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.

@phil-davis phil-davis force-pushed the render_fix_in_config_sample branch from 6b5ac43 to fa5530f Compare June 17, 2026 03:56
@phil-davis phil-davis marked this pull request as ready for review June 17, 2026 03:57
@DeepDiver1975 DeepDiver1975 merged commit 10e6dfa into master Jun 17, 2026
26 checks passed
@DeepDiver1975 DeepDiver1975 deleted the render_fix_in_config_sample branch June 17, 2026 04:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants