Update Autotest coding style guide for hanging indentation.
- use 8 spaces for hanging indentation, examples included
BUG=chromium:231976
TEST=None (doc change only)
Change-Id: Iea3e0692cc33a14e91799a6f5d8239a4cbcf85e6
Reviewed-on: https://gerrit.chromium.org/gerrit/48223
Reviewed-by: Scott Zawalski <scottz@chromium.org>
Tested-by: Tan Gao <tgao@chromium.org>
Commit-Queue: Tan Gao <tgao@chromium.org>
diff --git a/CODING_STYLE b/CODING_STYLE
index 777cc1d..0fcd091 100644
--- a/CODING_STYLE
+++ b/CODING_STYLE
@@ -24,6 +24,25 @@
Indentation is now 4 spaces, as opposed to hard tabs (which it used to be).
This is the Python standard.
+For hanging indentation, use 8 spaces plus all args should be on the new line.
+
+ # Either of the following hanging indentation is considered acceptable.
+YES: return 'class: %s, host: %s, args = %s' % (
+ self.__class__.__name__, self.hostname, self.args)
+
+YES: return 'class: %s, host: %s, args = %s' % (
+ self.__class__.__name__,
+ self.hostname,
+ self.args)
+
+ # Do not use 4 spaces for hanging indentation
+NO: return 'class: %s, host: %s, args = %s' % (
+ self.__class__.__name__, self.hostname, self.args)
+
+ # Do put all args on new line
+NO: return 'class: %s, host: %s, args = %s' % (self.__class__.__name__,
+ self.hostname, self.args)
+
Don't leave trailing whitespace, or put whitespace on blank lines.
Leave TWO blank lines between functions - this is Python, there are no clear
function end markers, and we need help.