Fix some reST field lists in docstrings

Code Issues Proposed changes

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: I87e77a9bbd5bcb834b35460ce0adff5bc59d9168

This commit is contained in:

XieYingYun

2017年03月25日 16:48:39 +08:00

parent 91fc844e7b

commit 36b1a2f69f

3 changed files with 4 additions and 4 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download Patch File Download Diff File Expand all files Collapse all files

4
test/probe/test_replication_servers_working.py

View File

@@ -34,7 +34,7 @@ def collect_info(path_list):

Recursive collect dirs and files in path_list directory.

:param path_list: start directory for collecting

:return files_list, dir_list: tuple of included

:return: files_list, dir_list tuple of included

directories and files

"""

files_list = []

@@ -56,7 +56,7 @@ def find_max_occupancy_node(dir_list):

Find node with maximum occupancy.

:param list_dir: list of directories for each node.

:return number: number node in list_dir

:return: number number node in list_dir

"""

count = 0

number = 0

Fix some reST field lists in docstrings

4 test/probe/test_replication_servers_working.py Unescape Escape View File

4
test/probe/test_replication_servers_working.py

View File