openstack
/
oslo.service
Code Issues Proposed changes

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: I242b83c5713cc1faa30dcdffa2d989fb9a63b3ef
Co-Authored-By: Stephen Finucane <sfinucan@redhat.com>
This commit is contained in:
Duan Jiong 2017-03-22 18:08:10 +08:00 committed by Stephen Finucane
parent dd941b0e1c
commit add1b72780
2 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
oslo_service/service.py
View File

@ -239,8 +239,7 @@ class Launcher(object):
"""Reload config files and restart service.
:returns: The return value from reload_config_files or
mutate_config_files, according to the restart_method.
mutate_config_files, according to the restart_method.
"""
if self.restart_method == 'reload':
self.conf.reload_config_files()

6
oslo_service/tests/base.py
View File

@ -39,7 +39,7 @@ class ServiceBaseTestCase(test_base.BaseTestCase):
def get_new_temp_dir(self):
"""Create a new temporary directory.
:returns fixtures.TempDir
:returns: fixtures.TempDir
"""
return self.useFixture(fixtures.TempDir())
@ -48,7 +48,7 @@ class ServiceBaseTestCase(test_base.BaseTestCase):
Returns the same directory during the whole test case.
:returns fixtures.TempDir
:returns: fixtures.TempDir
"""
if not hasattr(self, '_temp_dir'):
self._temp_dir = self.get_new_temp_dir()
@ -67,7 +67,7 @@ class ServiceBaseTestCase(test_base.BaseTestCase):
:type filename: string
:param root: temporary directory to create a new file in
:type root: fixtures.TempDir
:returns absolute file path string
:returns: absolute file path string
"""
root = root or self.get_default_temp_dir()
return root.join(filename)