Code guidelines - proposal

[Anne Ghisla]

Hi all!

as we start be enough to make mess in the code, I would discuss about
code guidelines for edits. Sadly SVN considers formatting modifications
as diffs, e.g. when indentations are changed from tabs to spaces.

It is also maybe early to bother about that, considering that we have a
good load of work already, but I think it's better to state this formal
things as soon as possible, what do you think?

A first reference is:
http://www.python.org/dev/peps/pep-0008/

see also what GRASS has decided for Python:
http://svn.osgeo.org/grass/grass/trunk/SUBMITTING_PYTHON

I'd also like to use PyLint
http://www.logilab.org/project/pylint

and I volunteer to get it running on DPM.

feedback is welcome!

regards,
Anne
--
http://wiki.osgeo.org/wiki/Anne_Ghisla

[Simon Morris]

On Wed, 2010-10-13 at 11:42 +0200, Anne Ghisla wrote:
> Hi all!

Hello! How amazing was the Chilean miners release yesterday - long time
since there has been such good news on the TV.

> as we start be enough to make mess in the code, I would discuss about
> code guidelines for edits. Sadly SVN considers formatting modifications
> as diffs, e.g. when indentations are changed from tabs to spaces.
>
> It is also maybe early to bother about that, considering that we have a
> good load of work already, but I think it's better to state this formal
> things as soon as possible, what do you think?

[snip]

>
> and I volunteer to get it running on DPM.
>

I support this entirely. I only read the PEP8 and the Django code
standards that they use internally after writing some of the code for
django-project-management so there are a few exceptions.

If you want to clean up code that would be great, but at the moment
there will be a lot of changes heading into trunk from
branches/rest-api-branch in about a week so it might we worth delaying
until then.

At that point I think we can start to add new features too - I have been
reading Markus' wish list again

Thanks

~sm

[Anne Ghisla]

On Thu, 2010-10-14 at 16:21 +0100, Simon Morris wrote:
> On Wed, 2010-10-13 at 11:42 +0200, Anne Ghisla wrote:
> > Hi all!
>
> Hello! How amazing was the Chilean miners release yesterday - long time
> since there has been such good news on the TV.

definitely. :)

> > as we start be enough to make mess in the code, I would discuss about
> > code guidelines for edits. Sadly SVN considers formatting modifications
> > as diffs, e.g. when indentations are changed from tabs to spaces.
> >
> > It is also maybe early to bother about that, considering that we have a
> > good load of work already, but I think it's better to state this formal
> > things as soon as possible, what do you think?
>
> [snip]
>
> >
> > and I volunteer to get it running on DPM.
> >
>
> I support this entirely. I only read the PEP8 and the Django code
> standards that they use internally after writing some of the code for
> django-project-management so there are a few exceptions.
>
> If you want to clean up code that would be great, but at the moment
> there will be a lot of changes heading into trunk from
> branches/rest-api-branch in about a week so it might we worth delaying
> until then.

Sure, it should not be an obstacle to development. Let me know when I
can start working. In the meanwhile I will learn how to master pylint :)

> At that point I think we can start to add new features too - I have been
> reading Markus' wish list again

great!

> Thanks

thanks,
Anne
--
http://wiki.osgeo.org/wiki/Anne_Ghisla