From: Rob van der Linde <rob@catalyst.net.nz>
Date: Wed, 4 Oct 2023 22:29:59 +0000 (+1300)
Subject: python: move comment for check_bytes to docstring
X-Git-Tag: talloc-2.4.2~1149
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=e209b8d79c2f232ba668bfff79c8bda951895084;p=thirdparty%2Fsamba.git

python: move comment for check_bytes to docstring

Signed-off-by: Rob van der Linde <rob@catalyst.net.nz>
Reviewed-by: Douglas Bagnall <douglas.bagnall@catalyst.net.nz>
Reviewed-by: Andrew Bartlett <abartlet@samba.org>
---

diff --git a/python/samba/getopt.py b/python/samba/getopt.py
index e6fe6ab57a3..f6d754eb6d5 100644
--- a/python/samba/getopt.py
+++ b/python/samba/getopt.py
@@ -365,11 +365,12 @@ class CredentialsOptionsDouble(CredentialsOptions):
         return self.creds2
 
 
-# Custom option type to allow the input of sizes using byte, kb, mb ...
-# units, e.g. 2Gb, 4KiB ...
-#    e.g. Option("--size", type="bytes", metavar="SIZE")
-#
 def check_bytes(option, opt, value):
+    """Custom option type to allow the input of sizes using byte, kb, mb ...
+
+    units, e.g. 2Gb, 4KiB ...
+       e.g. Option("--size", type="bytes", metavar="SIZE")
+    """
 
     multipliers = {"B": 1,
                    "KB": 1024,