openstack/python-openstackclient
Code Issues Proposed changes

Update URL for global hacking doc and fix typos

Browse Source 
* related to I579e7c889f3addc2cd40bce0c584bbc70bf435e2

Change-Id: I519155d0a47564ce18a9cd930378a3c4feaa7a77
This commit is contained in:
Joe Gordon 2013-11-11 11:09:04 -08:00
parent e118f216db
commit c946192e37
1 changed files with 6 additions and 6 deletions

12
HACKING.rst

@ -1,9 +1,9 @@
OpenStack Style Commandments OpenStack Style Commandments
============================ ============================
Step 0: Read https://github.com/openstack-dev/hacking/blob/master/HACKING.rst - Step 1: Read the OpenStack Style Commandments
Step 1: Read http://www.python.org/dev/peps/pep-0008/ one more time http://docs.openstack.org/developer/hacking/
Step 2: Read on - Step 2: Read on
General General
------- -------
@ -27,7 +27,7 @@ Calling Methods
--------------- ---------------
Deviation! When breaking up method calls due to the 79 char line length limit, Deviation! When breaking up method calls due to the 79 char line length limit,
use the alternate 4 space indent. With the frist argument on the succeeding use the alternate 4 space indent. With the first argument on the succeeding
line all arguments will then be vertically aligned. Use the same convention line all arguments will then be vertically aligned. Use the same convention
used with other data structure literals and terminate the method call with used with other data structure literals and terminate the method call with
the last argument line ending with a comma and the closing paren on its own the last argument line ending with a comma and the closing paren on its own
@ -87,7 +87,7 @@ commandline arguments, etc.) should be presumed to be encoded as utf-8.
Python 3.x Compatibility Python 3.x Compatibility
------------------------ ------------------------
OpenStackClient strives to be Python 3.3 compatibile. Common guidelines: OpenStackClient strives to be Python 3.3 compatible. Common guidelines:
* Convert print statements to functions: print statements should be converted * Convert print statements to functions: print statements should be converted
to an appropriate log or other output mechanism. to an appropriate log or other output mechanism.
@ -97,7 +97,7 @@ OpenStackClient strives to be Python 3.3 compatibile. Common guidelines:
Running Tests Running Tests
------------- -------------
Note: Oh boy, are we behing on writing tests. But they are coming! Note: Oh boy, are we behind on writing tests. But they are coming!
The testing system is based on a combination of tox and testr. If you just The testing system is based on a combination of tox and testr. If you just
want to run the whole suite, run `tox` and all will be fine. However, if want to run the whole suite, run `tox` and all will be fine. However, if