search

microsoft / api-guidelines

Microsoft REST API Guidelines
Other
22.69k stars 2.71k forks source link

Remove guidance for two-letter acronyms #405

Closed corranrogue9 closed 1 year ago

corranrogue9 commented 1 year ago

To resolve this issue, I am removing the guidance in our naming conventions that two-letter acronyms should have both characters capitalized. We don't seem to follow this guidance, and it causes confusion about "ID" being in a name (i.e. should it be myID or myId).

OlgaPodo commented 1 year ago

@corranrogue9 I think that the auxiliary verb SHOULD indicates a guideline that API designers should generally follow, but there are exceptions when the rule does not apply. I think that removing this rule would create uncertainty. I would like to close this PR without merging.