From 2ea2e761ebbab57cd7df7ff5a078a2849edfd19c Mon Sep 17 00:00:00 2001 From: Everett Toews Date: Mon, 17 Aug 2015 16:29:36 -0500 Subject: [PATCH] Improve the from_config doc Change-Id: I93ef96a0c2e1f26f11e458cdb7c028873e862ab5 --- doc/source/users/connection.rst | 4 ++++ openstack/connection.py | 4 +++- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/doc/source/users/connection.rst b/doc/source/users/connection.rst index 71659c01..70301a29 100644 --- a/doc/source/users/connection.rst +++ b/doc/source/users/connection.rst @@ -2,6 +2,10 @@ Connection ========== .. automodule:: openstack.connection + from_config + ----------- + .. autofunction:: openstack.connection.from_config + Connection Object ----------------- diff --git a/openstack/connection.py b/openstack/connection.py index 9ab0de8c..3ee21c50 100644 --- a/openstack/connection.py +++ b/openstack/connection.py @@ -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