Skip to content

Commit dbeecb8

Browse files
Function comment converted to correct format
1 parent 0dbd42a commit dbeecb8

File tree

3 files changed

+20
-3
lines changed

3 files changed

+20
-3
lines changed

packages/mbed-greentea/setup.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,16 @@
3232
OWNER_NAMES = 'Anna Bridge, Azim Khan'
3333
3434

35-
# Utility function to cat in a file (used for the README)
35+
3636
def read(fname):
37+
"""
38+
Utility function to cat in a file (used for the README)
39+
@param fname: the name of the file to read, relative to the directory containing this file
40+
@return: The string content of the opened file
41+
"""
3742
return open(os.path.join(os.path.dirname(__file__), fname), encoding="utf-8").read()
3843

44+
3945
setup(name='mbed-greentea',
4046
version='1.7.1',
4147
description=DESCRIPTION,

packages/mbed-host-tests/setup.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,15 @@
3232
3333

3434

35-
# Utility function to cat in a file (used for the README)
3635
def read(fname):
36+
"""
37+
Utility function to cat in a file (used for the README)
38+
@param fname: the name of the file to read, relative to the directory containing this file
39+
@return: The string content of the opened file
40+
"""
3741
return open(os.path.join(os.path.dirname(__file__), fname), encoding="utf8").read()
3842

43+
3944
setup(name='mbed-host-tests',
4045
version='1.5.7',
4146
description=DESCRIPTION,

packages/mbed-ls/setup.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,16 @@
2929
3030

3131

32-
# Utility function to cat in a file (used for the README)
32+
3333
def read(fname):
34+
"""
35+
Utility function to cat in a file (used for the README)
36+
@param fname: the name of the file to read, relative to the directory containing this file
37+
@return: The string content of the opened file
38+
"""
3439
return open(os.path.join(os.path.dirname(__file__), fname), encoding="utf8").read()
3540

41+
3642
setup(name='mbed-ls',
3743
version='1.7.7',
3844
description=DESCRIPTION,

0 commit comments

Comments
 (0)