@@ -154,4 +154,31 @@ Other: examples.py: Simple example classes. +Guidelines +---------- +Following the Python coding guidelines +<http://www.python.org/dev/peps/pep-0008/> indentation should be 4 spaces +(no tabs), function and method names should be lowercase_with_underscore(), +and files should contain a __version__ property, like this: + + __version__ = "$Revision$" + # $HeadURL$ + +It should be placed after the module docstring. + +This inhibits that for each .py file, the svn:keywords property should be set +to "Revision HeadURL". This can be done manually: + + $ svn propset svn:keywords "Revision HeadURL" myfile.py + +or by configuring your ~/.subversion/config file to use auto-props: + + [miscellany] + # ... + enable-auto-props = yes + + [auto-props] + # ... + *.py = svn:keywords=Revision HeadURL + README.txt @@ -87,8 +87,7 @@ include-ids=no enable-basic=yes # Required attributes for module, separated by a comma -required-attributes= -#required-attributes=__revision__ +required-attributes=__version__ # Regular expression which should only match functions or classes name which do # not require a docstring pylintrc 004e7c6b43247fd4450abc69a2e5ccfe2a9e8931 Arjan Molenaar gaphor@gmail.com http://github.com/amolenaar/gaphas/commit/9ebaa1864e35423a8f74a827e5a4f57155073020 9ebaa1864e35423a8f74a827e5a4f57155073020 2006-04-27T03:16:43-07:00 2006-04-27T03:16:43-07:00 Updated README.txt with a word about versioning. 2ad74419f2083a37bac19739c7fc1ddbd5186b12 Arjan Molenaar gaphor@gmail.com