Inconsistent Coding Standard Employed

Bug #413738 reported by Duncan McGreggor
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Landscape Server
Fix Released
Low
Duncan McGreggor
txAWS
Fix Released
Medium
Duncan McGreggor

Bug Description

As mentioned in a recent email to the list, the naming convention used for
methods in txAWS is split between camelCase and standard PEP-8 usage.

This needs to be resolved as quickly as possible, since there's a good chance
we're going to start using this code at Canonical and adding more stuff to it
as time goes on. The coding standard needs to be consistent across the code
base..

Also, we want to make this kind of API-breaking change now, before the library
is used too widely to do this easily.

Grep'ing the code, it seems that the Twisted standard of camelCase is most
prominently used. As this is a Twisted project and this standard already holds
the majority, I propose to make the necessary changes in a new branch using the
Twisted standard.

Does anyone have any violent objections to this?

Tags: cleanup

Related branches

Changed in txaws:
importance: Undecided → Medium
assignee: nobody → Duncan McGreggor (oubiwann)
Revision history for this message
Robert Collins (lifeless) wrote : Re: [Txawsteam] [Bug 413738] [NEW] Inconsistent Coding Standard Employed

Well, its a project /for use with/ twisted - not the same thing as being
part of twisted at all. And the python standard - pep8 - discourages
camelCase.

I'd much rather not use camel case.

I doubt I'll get violent about it though.

-Rob

Revision history for this message
Duncan McGreggor (oubiwann) wrote :

*chuckles*

Well, Thomas is +0 (either one is fine by him), and I guess I naturally lean towards the Twisted standard. But I wouldn't be unhappy with either. If no one else speaks up, we can go with PEP-8.

Revision history for this message
Duncan McGreggor (oubiwann) wrote :

Tristen also voted the towards using the Twisted standard. The branch that I started last week is sponsored by Canonical, and in the Landscape team we use PEP-8, so there's more code now that uses PEP-8, so we'll go down that route.

Revision history for this message
Duncan McGreggor (oubiwann) wrote :

Merged 413738-method-name-cleanup [r=lifeless] [f=413738]

Fixed method names, import ordering, and other cleanups.

Changed in txaws:
status: New → Fix Committed
Changed in landscape:
assignee: nobody → Duncan McGreggor (oubiwann)
importance: Undecided → Low
milestone: none → 1.3.5
status: New → Fix Committed
tags: added: needs-testing
tags: removed: needs-testing
Changed in landscape:
status: Fix Committed → Fix Released
Changed in txaws:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.