Differences between revisions 1 and 2
Revision 1 as of 2005-11-13 03:02:12
Size: 301
Comment:
Revision 2 as of 2005-11-16 11:10:52
Size: 1410
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
I am a MoinMoin wiki developer (also in Python) and Linux user.
Line 3: Line 5:
I am a MoinMoin wiki developer (also in Python) and Linux user. We currently use GNU Arch for our MoinMoin repository, but after some playing with mercurial and having a working converter, who knows... - I like good Python programs. :)
Line 5: Line 7:
We currently use GNU Arch for our MoinMoin repository, but after some playing with mercurial and having a working converter, who knows... - I like good Python programs. :) = How to improve Mercurial =
I am new to hg, so take this with a grain of salt:
 * run pychecker more often - although it might give some false alarms, it often points out strange places in the src and sometimes even severe errors.
 * read and follow pep-0008 and maybe put multiple statements on multiple lines (even for single line blocks under some "if"), makes it more readable
 * make sure every py src code file begins like:
 {{{
#!/usr/bin/env python (optional, for tools)
# -*- coding: iso-8859-1 -*- (or ascii or utf-8, just to make things clear)
"""
What this file does in a single line.

What this file does in some more detailed description...

@license: GNU GPL, see COPYING for details.
@copyright: 2005 Firstname Lastname <email>
@copyright: 2005 more authors...
"""
}}}
 This stuff could be put into some _header.py so one can easily use it when starting a new file.
 * make sure your src code files end with an empty line (makes it easier for diff, avoids "missing end of line at eof warnings")
 * use epydoc docstrings and generate docs using epydoc tool

I am a MoinMoin wiki developer (also in Python) and Linux user.

See ThomasWaldmann and ThomasWaldmann.

We currently use GNU Arch for our MoinMoin repository, but after some playing with mercurial and having a working converter, who knows... - I like good Python programs. :)

How to improve Mercurial

I am new to hg, so take this with a grain of salt:

  • run pychecker more often - although it might give some false alarms, it often points out strange places in the src and sometimes even severe errors.
  • read and follow pep-0008 and maybe put multiple statements on multiple lines (even for single line blocks under some "if"), makes it more readable
  • make sure every py src code file begins like:
    # -*- coding: iso-8859-1 -*-    (or ascii or utf-8, just to make things clear)
    """
    What this file does in a single line.
    
    What this file does in some more detailed description...
    
    @license: GNU GPL, see COPYING for details.
    @copyright: 2005 Firstname Lastname <email>
    @copyright: 2005 more authors...
    """
    This stuff could be put into some _header.py so one can easily use it when starting a new file.
  • make sure your src code files end with an empty line (makes it easier for diff, avoids "missing end of line at eof warnings")
  • use epydoc docstrings and generate docs using epydoc tool

ThomasWaldmann (last edited 2009-05-19 19:31:03 by localhost)