Python conventions

MartinRinehart at gmail.com MartinRinehart at gmail.com
Thu Apr 10 11:49:07 EDT 2008


I assembled a good conventions set for Java. View it at
http://www.martinrinehart.com/articles/code-conventions.html (is that
better, Steve?)

It followed a logical organization; it was built from four other
extensive (if not well-organized) convention sets and it scrupulously
avoided injecting my own biases. Where there were disagreements, they
were noted and the opposing viewpoints explained.

I'm appointing myself project secretary of a similar effort for
Python, until we can find someone better qualified (Python experience
pre-dating my late '07 start would be better qualified). The
secretary's job is to ask questions and correctly record answers.
First question:

global (e.g., what language for comments)
package
module
class
  methods
  data
function
statement
expression
variable

Is this a good outer-level organization?

For each topic, cover:

documentation
naming convention(s)
format

Second question: are the above the items we cover for each topic?
Others?



More information about the Python-list mailing list