Allow Rule description to span lines

erik · Jan 15, 2019 · de8b31d · de8b31d
1 parent 0d22caa
commit de8b31d
Showing 1 changed file with 6 additions and 3 deletions.
diff --git a/squabble/rules/__init__.py b/squabble/rules/__init__.py
@@ -39,15 +39,16 @@ def meta(cls):
 
         >>> class MyRule(BaseRule):
         ...     '''
-        ...     Brief description of rule.
+        ...     Brief description of rule. This can
+        ...     wrap to the next line.
         ...
         ...     More details about this rule.
         ...     '''
         >>> m = MyRule.meta()
         >>> m['name']
         'MyRule'
         >>> m['description']
-        'Brief description of rule.'
+        'Brief description of rule. This can wrap to the next line.'
         >>> m['help']
         'More details about this rule.'
         """
@@ -57,9 +58,11 @@ def meta(cls):
         if len(split_doc) == 2:
             help = split_doc[1]
 
+        description = split_doc[0].replace('\n', ' ')
+
         return {
             'name': cls.__name__,
-            'description': split_doc[0],
+            'description': description,
             'help': help
         }