From f6645b43e6f46611696049cc28481d2522cfe259 Mon Sep 17 00:00:00 2001 From: Jake Hunsaker Date: Thu, 9 Jan 2020 15:30:22 -0500 Subject: [global] PEP 257 docstring fixes PEP 257 specifies docstrings should always use triple double quotes, rather than triple single quotes. This commit corrects the places where triple single quotes are used incorrectly, most of which were done by yours truly. Resolves: #1914 Signed-off-by: Jake Hunsaker --- example_plugins/example.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'example_plugins') diff --git a/example_plugins/example.py b/example_plugins/example.py index 2e39ffee..ac4bc790 100755 --- a/example_plugins/example.py +++ b/example_plugins/example.py @@ -12,7 +12,7 @@ from sos.plugins import Plugin, RedHatPlugin # if you want to override it simply provide a @classmethod name() # that returns the name you want class example(Plugin, RedHatPlugin): - '''This is the description for the example plugin''' + """This is the description for the example plugin""" # Plugin developers want to override setup() from which they will call # add_copy_spec() to collect files and collectExtOutput() to collect programs # output. @@ -27,13 +27,13 @@ class example(Plugin, RedHatPlugin): ('color', 'Gathers toenail polish color', 'fast', 0)] def setup(self): - ''' First phase - Collect all the information we need. + """ First phase - Collect all the information we need. Directories are copied recursively. arbitrary commands may be executed using the collectExtOutput() method. Information is automatically saved, and links are presented in the report to each file or directory which has been copied to the saved tree. Also, links are provided to the output from each command. - ''' + """ # Here's how to copy files and directory trees self.add_copy_spec("/etc/hosts") -- cgit