Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:123159
Message-ID: <91f7e39b-ff2e-471e-86c9-b18e4492fb72@bastelstu.be>
Date: Fri, 19 Apr 2024 21:10:14 +0200
Precedence: bulk
MIME-Version: 1.0
Subject: Re: [PHP-DEV] [RFC] Casing of acronyms in class and method names
To: Bilge <bilge@scriptfusion.com>, internals@lists.php.net
References: <792b2282-b7a3-40dd-899c-daab55353316@bastelstu.be>
 <f7efdf8c-826f-460e-80c0-53f4ca27e8cb@bastelstu.be>
 <08200b2f-55ca-4e8f-aeb3-d5b07bf3ae3c@scriptfusion.com>
Content-Language: en-US
In-Reply-To: <08200b2f-55ca-4e8f-aeb3-d5b07bf3ae3c@scriptfusion.com>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 8bit
From: tim@bastelstu.be (=?UTF-8?Q?Tim_D=C3=BCsterhus?=)

Hi

On 4/19/24 20:47, Bilge wrote:
> Not that my opinion counts for much, but I have to say I find this very odd.
> 
> Good class names:
> Id // Identifier
> ID // Identity Document
> 
> I understand the distinction you wish to make here, between an acronym
> and abbreviation, but I think it's a meaningless distinction. In this
> case, `Id` would be fine for "identifier", but "Identity Document"
> should simply be `IdentityDocument`. Whilst the distinction may seem
> meaningful to you, it certainly does not look that way to me; I think it
> would be difficult to remember and explain to someone else. Perhaps the
> tie breaker could be that it wouldn't be meaningful to an automated
> style checker, either. That is, it would be difficult to enforce this
> policy exception in any automated way. Why not just keep it simple and
> consistent here, disallowing runs of multiple upper-case letters?

I have copied the example identifiers verbatim from the existing 
phrasing in CODING_STANDARDS.md and just moved them into the correct 
section according to the updated wording.

However 'ID' as-in 'Identity Document' should also be 'Id' with the 
updated policy, which I missed. Or rather it should not be abbreviated 
at all.

I've adjusted the examples [1], thank you for pointing this out!

Best regards
Tim Düsterhus

[1] 
https://wiki.php.net/rfc/class-naming-acronyms?do=diff&rev2%5B0%5D=1712419286&rev2%5B1%5D=1713553737&difftype=sidebyside