Use inspect.cleandoc for BaseRule.get_meta

erik · Jan 10, 2019 · fdcfef9 · fdcfef9
1 parent ff82204
commit fdcfef9
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/squabble/cli.py b/squabble/cli.py
@@ -158,7 +158,7 @@ def show_rule(name):
             **color
         }))
 
-    print('{bold}{name}{reset} - {description}\n{help}'.format(**{
+    print('{bold}{name}{reset} - {description}\n\n{help}'.format(**{
         **meta,
         **color
     }))

diff --git a/squabble/rules/__init__.py b/squabble/rules/__init__.py
@@ -1,3 +1,5 @@
+import inspect
+
 from squabble.rule import Registry
 
 
@@ -49,7 +51,7 @@ def meta(cls):
         >>> m['help']
         'More details about this rule.'
         """
-        split_doc = (cls.__doc__ or '').strip().split('\n', 1)
+        split_doc = inspect.cleandoc(cls.__doc__ or '').split('\n\n', 1)
 
         help = None
         if len(split_doc) == 2: