Opened 7 years ago

Last modified 2 years ago

#2926 enhancement new

Various names in twisted.protocols.amp do not conform to coding standard recommendation for acronyms

Reported by: glyph Owned by:
Priority: low Milestone:
Component: core Keywords:
Cc: itamarst, thijs Branch:
Author: Launchpad Bug:

Description

Quoth the coding standard:

"Acronyms should be capitalized in their entirety."

but AMP contains a few names which do not do this:

  • AmpBox
  • AmpError
    • RemoteAmpError
  • AmpList

These should all be very gradually deprecated and replaced with names such as AMPBox, AMPError, RemoteAMPError, AMPList.

Change History (4)

comment:1 Changed 7 years ago by itamarst

  • Cc itamarst added

This seems silly; "amp" is fairly non-acronymy (has a vowel, is a real word.) The fact it also matches an acronym is nice, but I think in this case changing all uses to caps seems kinda pedantic. Compare to HTTP, that is unpronouncable, not a real word, and much more obviously an acronym.

comment:2 Changed 7 years ago by glyph

It is a little silly, which is why I put it at "low" priority. However, the AMP class itself follows the coding standard, and consistency dictates that these should too.

comment:3 Changed 4 years ago by <automation>

  • Owner glyph deleted

comment:4 Changed 2 years ago by thijs

  • Cc thijs added
Note: See TracTickets for help on using tickets.