summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2016-07-26 07:22:27 +0000
committerGerrit Code Review <review@openstack.org>2016-07-26 07:22:27 +0000
commit566b8566c00447b8ee8519debde56ddf0e7bf4cf (patch)
tree96fe3b6f30e7247913ed17cc052e7d0c45146ce9 /doc/source
parent08ba2aa97851eaa93be20cfc39d842b383e21435 (diff)
parentf996138a0d0c1ea16a1c3e90e63eedcf8fa53148 (diff)
downloadpython-openstackclient-566b8566c00447b8ee8519debde56ddf0e7bf4cf.tar.gz
Merge "Standardize import format"
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/developing.rst34
1 files changed, 34 insertions, 0 deletions
diff --git a/doc/source/developing.rst b/doc/source/developing.rst
index 95a04073..c5092cc0 100644
--- a/doc/source/developing.rst
+++ b/doc/source/developing.rst
@@ -173,3 +173,37 @@ or
.. code-block:: bash
$ pip install -e .
+
+Standardize Import Format
+=========================
+
+.. _`Import Order Guide`: http://docs.openstack.org/developer/hacking/#imports
+
+The import order shows below:
+
+* {{stdlib imports in human alphabetical order}}
+* \n
+* {{third-party lib imports in human alphabetical order}}
+* \n
+* {{project imports in human alphabetical order}}
+* \n
+* \n
+* {{begin your code}}
+
+Example
+~~~~~~~
+
+.. code-block:: python
+
+ import copy
+ import fixtures
+ import mock
+ import os
+
+ from osc_lib.api import auth
+ from osc_lib import utils
+ import six
+
+ from openstackclient import shell
+ from openstackclient.tests import utils
+