Improve the from_config doc

Change-Id: I93ef96a0c2e1f26f11e458cdb7c028873e862ab5
This commit is contained in:
Everett Toews
2015-08-17 16:29:36 -05:00
parent b5056b3cdc
commit 2ea2e761eb
2 changed files with 7 additions and 1 deletions

View File

@@ -2,6 +2,10 @@ Connection
==========
.. automodule:: openstack.connection
from_config
-----------
.. autofunction:: openstack.connection.from_config
Connection Object
-----------------

View File

@@ -78,7 +78,9 @@ def from_config(opts):
Create a :class:`~openstack.connection.Connection` from a configuration
similar to a os-client-config CloudConfig.
:param opts: Options class like the argparse Namespace object.
:param opts: An options class like the :class:`~argparse.Namespace` class.
:rtype: :class:`~openstack.connection.Connection`
"""
# TODO(thowe): I proposed that service name defaults to None in OCC