Skip to content

Commit a50c62d

Browse files
mchehabJonathan Corbet
authored andcommitted
docs: kabi: system_symbols: end docstring phrases with a dot
Some docstring classes are not ending with a dot. Fix to make it more uniform. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <efd0e150d8e12d8ea2665f54a96b1997f32897b7.1768838938.git.mchehab+huawei@kernel.org>
1 parent ff91637 commit a50c62d

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

tools/lib/python/abi/system_symbols.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@
1818
from abi.helpers import AbiDebug
1919

2020
class SystemSymbols:
21-
"""Stores arguments for the class and initialize class vars"""
21+
"""Stores arguments for the class and initialize class vars."""
2222

2323
def graph_add_file(self, path, link=None):
2424
"""
25-
add a file path to the sysfs graph stored at self.root
25+
add a file path to the sysfs graph stored at self.root.
2626
"""
2727

2828
if path in self.files:
@@ -43,7 +43,7 @@ def graph_add_file(self, path, link=None):
4343
self.files.add(path)
4444

4545
def print_graph(self, root_prefix="", root=None, level=0):
46-
"""Prints a reference tree graph using UTF-8 characters"""
46+
"""Prints a reference tree graph using UTF-8 characters."""
4747

4848
if not root:
4949
root = self.root
@@ -173,7 +173,7 @@ def __init__(self, abi, sysfs="/sys", hints=False):
173173
self._walk(sysfs)
174174

175175
def check_file(self, refs, found):
176-
"""Check missing ABI symbols for a given sysfs file"""
176+
"""Check missing ABI symbols for a given sysfs file."""
177177

178178
res_list = []
179179

@@ -214,7 +214,7 @@ def check_file(self, refs, found):
214214
return res_list
215215

216216
def _ref_interactor(self, root):
217-
"""Recursive function to interact over the sysfs tree"""
217+
"""Recursive function to interact over the sysfs tree."""
218218

219219
for k, v in root.items():
220220
if isinstance(v, dict):
@@ -232,7 +232,7 @@ def _ref_interactor(self, root):
232232

233233

234234
def get_fileref(self, all_refs, chunk_size):
235-
"""Interactor to group refs into chunks"""
235+
"""Interactor to group refs into chunks."""
236236

237237
n = 0
238238
refs = []
@@ -250,7 +250,7 @@ def get_fileref(self, all_refs, chunk_size):
250250

251251
def check_undefined_symbols(self, max_workers=None, chunk_size=50,
252252
found=None, dry_run=None):
253-
"""Seach ABI for sysfs symbols missing documentation"""
253+
"""Seach ABI for sysfs symbols missing documentation."""
254254

255255
self.abi.parse_abi()
256256

0 commit comments

Comments
 (0)