From 09ee4abb407f909b93caafbd3b0b02dac4feef59 Mon Sep 17 00:00:00 2001 From: yfzhao Date: Wed, 29 Mar 2017 18:33:54 +0800 Subject: [PATCH] Fix some reST field lists in docstrings Probably the most common format for documenting arguments is reST field lists [1]. This change updates some docstrings to comply with the field lists syntax. [1] http://sphinx-doc.org/domains.html#info-field-lists Change-Id: Ia43fca7fab8a61860b2554bf28b9323d2de62448 --- trove/datastore/models.py | 24 ++++++++++++------------ trove/tests/fakes/keystone.py | 2 +- 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/trove/datastore/models.py b/trove/datastore/models.py index e2af26c376..01638686eb 100644 --- a/trove/datastore/models.py +++ b/trove/datastore/models.py @@ -145,7 +145,7 @@ class Capabilities(object): defaults and overrides and provides the one structure that should be used as the interface to controlling capabilities per datastore. - :returns Capabilities: + :returns: Capabilities """ self = cls(datastore_version_id) self._load() @@ -166,7 +166,7 @@ class BaseCapability(object): """ The capability's id - :returns str: + :returns: str """ return self.db_info.id @@ -175,7 +175,7 @@ class BaseCapability(object): """ Is the capability/feature enabled? - :returns bool: + :returns: bool """ return self.db_info.enabled @@ -225,7 +225,7 @@ class CapabilityOverride(BaseCapability): """ The name of the capability. - :returns str: + :returns: str """ return self.parent_name @@ -234,7 +234,7 @@ class CapabilityOverride(BaseCapability): """ The description of the capability. - :returns str: + :returns: str """ return self.parent_description @@ -244,7 +244,7 @@ class CapabilityOverride(BaseCapability): Because capability overrides is an association table there are times where having the capability id is necessary. - :returns str: + :returns: str """ return self.db_info.capability_id @@ -253,7 +253,7 @@ class CapabilityOverride(BaseCapability): """ Generates a CapabilityOverride object from the capability_override id. - :returns CapabilityOverride: + :returns: CapabilityOverride """ try: return cls(DBCapabilityOverrides.find_by( @@ -274,7 +274,7 @@ class CapabilityOverride(BaseCapability): override to. :param enabled: Set enabled to True or False - :returns CapabilityOverride: + :returns: CapabilityOverride """ return CapabilityOverride( @@ -291,7 +291,7 @@ class Capability(BaseCapability): """ The Capability name - :returns str: + :returns: str """ return self.db_info.name @@ -300,7 +300,7 @@ class Capability(BaseCapability): """ The Capability description - :returns str: + :returns: str """ return self.db_info.description @@ -310,7 +310,7 @@ class Capability(BaseCapability): Generates a Capability object by looking up the capability first by ID then by name. - :returns Capability: + :returns: Capability """ try: return cls(DBCapabilities.find_by(id=capability_id_or_name)) @@ -326,7 +326,7 @@ class Capability(BaseCapability): """ Creates a new capability. - :returns Capability: + :returns: Capability """ return Capability(DBCapabilities.create( name=name, description=description, enabled=enabled)) diff --git a/trove/tests/fakes/keystone.py b/trove/tests/fakes/keystone.py index 29b2416e79..0d5e863caa 100644 --- a/trove/tests/fakes/keystone.py +++ b/trove/tests/fakes/keystone.py @@ -30,7 +30,7 @@ class AuthProtocol(object): """Convert header to wsgi env variable. :param key: http header name (ex. 'X-Auth-Token') - :return wsgi env variable name (ex. 'HTTP_X_AUTH_TOKEN') + :return: wsgi env variable name (ex. 'HTTP_X_AUTH_TOKEN') """ return 'HTTP_%s' % key.replace('-', '_').upper()