|
Jakub Ruzicka |
8f07a3a |
From 231f07379e1c090cd61d56e1d8eb383b10bd8943 Mon Sep 17 00:00:00 2001
|
|
Jakub Ruzicka |
8f07a3a |
From: Joe Gordon <joe.gordon0@gmail.com>
|
|
Jakub Ruzicka |
8f07a3a |
Date: Mon, 11 Nov 2013 11:09:04 -0800
|
|
Jakub Ruzicka |
8f07a3a |
Subject: [PATCH] Update URL for global hacking doc and fix typos
|
|
Jakub Ruzicka |
8f07a3a |
|
|
Jakub Ruzicka |
8f07a3a |
* related to I579e7c889f3addc2cd40bce0c584bbc70bf435e2
|
|
Jakub Ruzicka |
8f07a3a |
|
|
Jakub Ruzicka |
8f07a3a |
Change-Id: I519155d0a47564ce18a9cd930378a3c4feaa7a77
|
|
Jakub Ruzicka |
8f07a3a |
---
|
|
Jakub Ruzicka |
8f07a3a |
HACKING.rst | 12 ++++++------
|
|
Jakub Ruzicka |
8f07a3a |
1 file changed, 6 insertions(+), 6 deletions(-)
|
|
Jakub Ruzicka |
8f07a3a |
|
|
Jakub Ruzicka |
8f07a3a |
diff --git a/HACKING.rst b/HACKING.rst
|
|
Jakub Ruzicka |
8f07a3a |
index 15dca8f..8744a93 100644
|
|
Jakub Ruzicka |
8f07a3a |
--- a/HACKING.rst
|
|
Jakub Ruzicka |
8f07a3a |
+++ b/HACKING.rst
|
|
Jakub Ruzicka |
8f07a3a |
@@ -1,9 +1,9 @@
|
|
Jakub Ruzicka |
8f07a3a |
OpenStack Style Commandments
|
|
Jakub Ruzicka |
8f07a3a |
============================
|
|
Jakub Ruzicka |
8f07a3a |
|
|
Jakub Ruzicka |
8f07a3a |
-Step 0: Read https://github.com/openstack-dev/hacking/blob/master/HACKING.rst
|
|
Jakub Ruzicka |
8f07a3a |
-Step 1: Read http://www.python.org/dev/peps/pep-0008/ one more time
|
|
Jakub Ruzicka |
8f07a3a |
-Step 2: Read on
|
|
Jakub Ruzicka |
8f07a3a |
+- Step 1: Read the OpenStack Style Commandments
|
|
Jakub Ruzicka |
8f07a3a |
+ http://docs.openstack.org/developer/hacking/
|
|
Jakub Ruzicka |
8f07a3a |
+- Step 2: Read on
|
|
Jakub Ruzicka |
8f07a3a |
|
|
Jakub Ruzicka |
8f07a3a |
General
|
|
Jakub Ruzicka |
8f07a3a |
-------
|
|
Jakub Ruzicka |
8f07a3a |
@@ -27,7 +27,7 @@ Calling Methods
|
|
Jakub Ruzicka |
8f07a3a |
---------------
|
|
Jakub Ruzicka |
8f07a3a |
|
|
Jakub Ruzicka |
8f07a3a |
Deviation! When breaking up method calls due to the 79 char line length limit,
|
|
Jakub Ruzicka |
8f07a3a |
-use the alternate 4 space indent. With the frist argument on the succeeding
|
|
Jakub Ruzicka |
8f07a3a |
+use the alternate 4 space indent. With the first argument on the succeeding
|
|
Jakub Ruzicka |
8f07a3a |
line all arguments will then be vertically aligned. Use the same convention
|
|
Jakub Ruzicka |
8f07a3a |
used with other data structure literals and terminate the method call with
|
|
Jakub Ruzicka |
8f07a3a |
the last argument line ending with a comma and the closing paren on its own
|
|
Jakub Ruzicka |
8f07a3a |
@@ -87,7 +87,7 @@ commandline arguments, etc.) should be presumed to be encoded as utf-8.
|
|
Jakub Ruzicka |
8f07a3a |
Python 3.x Compatibility
|
|
Jakub Ruzicka |
8f07a3a |
------------------------
|
|
Jakub Ruzicka |
8f07a3a |
|
|
Jakub Ruzicka |
8f07a3a |
-OpenStackClient strives to be Python 3.3 compatibile. Common guidelines:
|
|
Jakub Ruzicka |
8f07a3a |
+OpenStackClient strives to be Python 3.3 compatible. Common guidelines:
|
|
Jakub Ruzicka |
8f07a3a |
|
|
Jakub Ruzicka |
8f07a3a |
* Convert print statements to functions: print statements should be converted
|
|
Jakub Ruzicka |
8f07a3a |
to an appropriate log or other output mechanism.
|
|
Jakub Ruzicka |
8f07a3a |
@@ -97,7 +97,7 @@ OpenStackClient strives to be Python 3.3 compatibile. Common guidelines:
|
|
Jakub Ruzicka |
8f07a3a |
Running Tests
|
|
Jakub Ruzicka |
8f07a3a |
-------------
|
|
Jakub Ruzicka |
8f07a3a |
|
|
Jakub Ruzicka |
8f07a3a |
-Note: Oh boy, are we behing on writing tests. But they are coming!
|
|
Jakub Ruzicka |
8f07a3a |
+Note: Oh boy, are we behind on writing tests. But they are coming!
|
|
Jakub Ruzicka |
8f07a3a |
|
|
Jakub Ruzicka |
8f07a3a |
The testing system is based on a combination of tox and testr. If you just
|
|
Jakub Ruzicka |
8f07a3a |
want to run the whole suite, run `tox` and all will be fine. However, if
|