view doc/v2_planning/coding_style.txt @ 1022:e21b3fdec4ef

add comments.
author Frederic Bastien <nouiz@nouiz.org>
date Fri, 03 Sep 2010 16:28:21 -0400
parents 53f6eb80abf1
children 1c96e7ad95c3
line wrap: on
line source

Discussion of Coding-Style
==========================

Participants
------------
- Dumitru
- Fred
- David
- Olivier D [leader unless David wants to be]

Existing Python coding style specifications and guidelines:
-----------------------------------------------------------

    * http://www.python.org/dev/peps/pep-0008/
    * http://google-styleguide.googlecode.com/svn/trunk/pyguide.html
    * http://www.voidspace.org.uk/python/articles/python_style_guide.shtml
    * http://python.net/~goodger/projects/pycon/2007/idiomatic/handout.html
    * http://www.cs.caltech.edu/courses/cs11/material/python/misc/python_style_guide.html
    * http://barry.warsaw.us/software/STYLEGUIDE.txt
    * http://self.maluke.com/style
    * http://chandlerproject.org/Projects/ChandlerCodingStyleGuidelines
    * http://lists.osafoundation.org/pipermail/dev/2003-March/000479.html
    * http://learnpython.pbworks.com/PythonTricks
    * http://eikke.com/how-not-to-write-python-code/
    * http://jaynes.colorado.edu/PythonGuidelines.html
    * http://docs.djangoproject.com/en/dev/internals/contributing/#coding-style

We will probably want to take PEP-8 as starting point, and read what other
people think about it / how other coding guidelines differ from it.

Documentation:
--------------

How do we write doc?

Python 3:
---------

Is it reasonable to have coding guidelines that would make the code as
compatible as possible with Python 3?


C coding style:
---------------

We also need a c-style coding style.