summaryrefslogtreecommitdiffstats
path: root/README.Coding
diff options
context:
space:
mode:
authorJelmer Vernooij <jelmer@samba.org>2011-07-17 13:33:03 +0200
committerJelmer Vernooij <jelmer@samba.org>2011-07-23 22:08:09 +0200
commit25054a3071d2cd8a7433ee9aed9f6a2b732bfbbc (patch)
tree9e235a4b3103a2d422969c231e5ef8411686c5ab /README.Coding
parentf10f6eff396d58c5cb1198a0f3d8c47a9650d329 (diff)
downloadsamba-25054a3071d2cd8a7433ee9aed9f6a2b732bfbbc.tar.gz
samba-25054a3071d2cd8a7433ee9aed9f6a2b732bfbbc.tar.xz
samba-25054a3071d2cd8a7433ee9aed9f6a2b732bfbbc.zip
README.Coding: Mention that PEP8 is the standard for Python code.
Almost all of our existing code is PEP8, and virtually every other free software project in Python uses PEP8.
Diffstat (limited to 'README.Coding')
-rw-r--r--README.Coding6
1 files changed, 5 insertions, 1 deletions
diff --git a/README.Coding b/README.Coding
index 3ea9c781aa..12997ccf9a 100644
--- a/README.Coding
+++ b/README.Coding
@@ -16,11 +16,15 @@ style should never outweigh coding itself and so the guidelines
described here are hopefully easy enough to follow as they are very
common and supported by tools and editors.
-The basic style, also mentioned in prog_guide4.txt, is the Linux kernel
+The basic style for C code, also mentioned in prog_guide4.txt, is the Linux kernel
coding style (See Documentation/CodingStyle in the kernel source tree). This
closely matches what most Samba developers use already anyways, with a few
exceptions as mentioned below.
+The coding style for Python code is documented in PEP8, http://www.python.org/pep/pep8.
+If you have ever worked on another free software python project, you are probably
+already familiar with it.
+
But to save you the trouble of reading the Linux kernel style guide, here
are the highlights.