openstack/swift
Code Issues Proposed changes

Fix some inconsistency in docstrings

Browse Source 
Added colon after ":returns" according to:
http://docs.openstack.org/developer/hacking

 blank lines are added before the param lines

Change-Id: I008bea270c6a4b7c80d1a84a2cb9fcc9b5a7264a
This commit is contained in:
hgangwx
2015-12-11 17:31:36 +08:00
parent 500f7e8d34
commit 52b534c9d1
1 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
swift/proxy/controllers/base.py
View File

@@ -337,9 +337,10 @@ def _get_cache_key(account, container):
"""
Get the keys for both memcache (cache_key) and env (env_key)
where info about accounts and containers is cached
:param account: The name of the account
:param container: The name of the container (or None if account)
:returns a tuple of (cache_key, env_key)
:returns: a tuple of (cache_key, env_key)
"""
if container:
@@ -357,10 +358,11 @@ def _get_cache_key(account, container):
def get_object_env_key(account, container, obj):
"""
Get the keys for env (env_key) where info about object is cached
:param account: The name of the account
:param container: The name of the container
:param obj: The name of the object
:returns a string env_key
:returns: a string env_key
"""
env_key = 'swift.object/%s/%s/%s' % (account,
container, obj)
@@ -461,7 +463,7 @@ def _get_info_cache(app, env, account, container=None):
:param app: the application object
:param env: the environment used by the current request
:returns the cached info or None if not cached
:returns: the cached info or None if not cached
"""
cache_key, env_key = _get_cache_key(account, container)