From abdb5ca0e78cf017b1353c5e2c39d76b237e6cf2 Mon Sep 17 00:00:00 2001 From: David Shrewsbury Date: Thu, 30 Apr 2015 14:58:57 -0400 Subject: [PATCH] Add minor OperatorCloud documentation The documentation for the OperatorCloud methods with docstrings will not be generated unless the class itself has a docstring. This adds a simple docstring just to get the documentation generated. Also adds a link to the CONTRIBUTING.rst doc pointing to the project documentation. Change-Id: I535289a938f68895c19b5e226d2e2302b566d00d --- CONTRIBUTING.rst | 5 ++++- shade/__init__.py | 2 ++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index ee1e32b0e..798b5b5af 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -24,6 +24,9 @@ signed OpenStack's contributor's agreement. Project Hosting Details ------------------------- +Project Documentation + http://docs.openstack.org/infra/shade/ + Bug tracker http://storyboard.openstack.org @@ -31,7 +34,7 @@ Mailing list (prefix subjects with ``[shade]`` for faster responses) http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-infra Code Hosting - * https://git.openstack.org/cgit/openstack-infra/shade + https://git.openstack.org/cgit/openstack-infra/shade Code Review https://review.openstack.org/#/q/status:open+project:openstack-infra/shade,n,z diff --git a/shade/__init__.py b/shade/__init__.py index 5cfae53c0..1bb7a99d7 100644 --- a/shade/__init__.py +++ b/shade/__init__.py @@ -2096,6 +2096,8 @@ class OpenStackCloud(object): class OperatorCloud(OpenStackCloud): + """Represent a privileged/operator connection to an OpenStack Cloud. + """ @property def auth_token(self):