Add requested comment for clarity

closes #629
pallets · Aug 15, 2018 · f9e0dbe · f9e0dbe
1 parent 93c371d
commit f9e0dbe
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/click/core.py b/click/core.py
@@ -778,6 +778,8 @@ def __init__(self, name, context_settings=None, callback=None,
         #: should show up in the help page and execute.  Eager parameters
         #: will automatically be handled before non eager ones.
         self.params = params or []
+        # if a form feed (page break) is found in the help text, truncate help
+        # text to the content preceding the first form feed
         if help and '\f' in help:
             help = help.split('\f', 1)[0]
         self.help = help