From c68f5d83c0a4ea4ccf87c7d1d5dd1e9f7b2907a3 Mon Sep 17 00:00:00 2001 From: Tim Graham Date: Mon, 12 Jun 2017 15:39:09 -0400 Subject: [PATCH] Fixed #27655 -- Added some guidelines to the coding style docs. --- .../writing-code/coding-style.txt | 21 +++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/internals/contributing/writing-code/coding-style.txt b/docs/internals/contributing/writing-code/coding-style.txt index e3ce27a99c..76b4918d09 100644 --- a/docs/internals/contributing/writing-code/coding-style.txt +++ b/docs/internals/contributing/writing-code/coding-style.txt @@ -33,6 +33,27 @@ Python style * Use four spaces for indentation. +* Use four space hanging indentation rather than vertical alignment:: + + raise AttributeError( + 'Here is a multine error message ' + 'shortened for clarity.' + ) + + Instead of:: + + raise AttributeError('Here is a multine error message ' + 'shortened for clarity.') + + This makes better use of space and avoids having to realign strings if the + length of the first line changes. + +* Use single quotes for strings, or a double quote if the the string contains a + single quote. Don't waste time doing unrelated refactoring of existing code + to conform to this style. + +* Avoid use of "we" in comments, e.g. "Loop over" rather than "We loop over". + * Use underscores, not camelCase, for variable, function and method names (i.e. ``poll.get_unique_voters()``, not ``poll.getUniqueVoters()``).