Skip to content

Undo capitalization of // no break to prevent tooling issues#113

Merged
Crell merged 1 commit intophp-fig:masterfrom
vdelau:lowercase_no_break
May 13, 2025
Merged

Undo capitalization of // no break to prevent tooling issues#113
Crell merged 1 commit intophp-fig:masterfrom
vdelau:lowercase_no_break

Conversation

@vdelau
Copy link
Copy Markdown
Member

@vdelau vdelau commented May 13, 2025

In PR 79 all comments where either replaced with ellipsis or capitalized. The // no break comment however is used literally in various tools and capitalizing this might lead to tooling regressions.

For reference, literal // no break seems to be a de-facto standard, even if it is not explicitly phrased as such:

In [PR 79](php-fig#79) all
comments where either replaced with ellipsis or capitalized. The
`// no break` comment however is used literally in various tools and
capitalizing this might lead to tooling regressions.
@Crell Crell merged commit 859b866 into php-fig:master May 13, 2025
@jrfnl
Copy link
Copy Markdown
Contributor

jrfnl commented May 13, 2025

For the record: the WordPress Coding Standards just look for a comment without a predefined contents. Quoting that as a reference to justify this change is not correct and shows this hasn't been validated/tested.

@lpd-au
Copy link
Copy Markdown
Contributor

lpd-au commented May 13, 2025

For the record: the WordPress Coding Standards just look for a comment without a predefined contents. Quoting that as a reference to justify this change is not correct and shows this hasn't been validated/tested.

The spec likewise only requires a comment, all this PR did was revert an unpublished change to the example (so it once again matches WordPress' example and works with PhpStorm + other tools).

@vdelau vdelau deleted the lowercase_no_break branch May 14, 2025 11:45
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.

4 participants