Skip to content

Expand Section 2.7 entry in the PER-CS 2.0 to 3.0 migration guide#146

Open
rodrigoprimo wants to merge 1 commit into
php-fig:masterfrom
rodrigoprimo:expand-section-2.7-in-migration-guide-3.0
Open

Expand Section 2.7 entry in the PER-CS 2.0 to 3.0 migration guide#146
rodrigoprimo wants to merge 1 commit into
php-fig:masterfrom
rodrigoprimo:expand-section-2.7-in-migration-guide-3.0

Conversation

@rodrigoprimo
Copy link
Copy Markdown
Contributor

PER-CS 3.0 introduced a new Section 2.7. It adopts the php-src naming conventions for abbreviations and acronyms, quoting them directly:

Abbreviations and acronyms as well as initialisms SHOULD be avoided wherever possible, unless they are much more widely used than the long form (e.g. HTTP or URL). Abbreviations, acronyms, and initialisms SHOULD be treated like regular words, thus they SHOULD be written with an uppercase first character, followed by lowercase characters.

In the spec, the SHOULD-avoid recommendation is the lead rule and the capitalization rule (XmlFormatter not XMLFormatter) is the dependent follow-on. The migration guide's existing Section 2.7 entry covered only the capitalization rule and omitted the SHOULD-avoid recommendation entirely.

This section was introduced by #102. This PR rewrites the entry so it leads with the SHOULD-avoid recommendation and keeps the capitalization rule as the follow-on.

PER-CS 3.0 introduced a new 2.7 section. The migration guide's existing
Section 2.7 entry covered the second part of the rule and omitted the
SHOULD-avoid recommendation entirely.

This commit rewrites the entry so it leads with the SHOULD-avoid rule
and keeps the capitalization rule as the follow-on, matching the order
in the spec.
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.

1 participant