zulip: Explain use cases for generate_option_group() method.

iishiishii · Sep 14, 2017 · 59320f6 · 59320f6
1 parent 631c64c
commit 59320f6
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/zulip/zulip/__init__.py b/zulip/zulip/__init__.py
@@ -170,6 +170,10 @@ def custom_error_handling(self, message):
                             file).''')
     return parser
 
+# This method might seem redundant with `add_default_arguments()`,
+# except for the fact that is uses the deprecated `optparse` module.
+# We still keep it for legacy support of out-of-tree bots and integrations
+# depending on it.
 def generate_option_group(parser, prefix=''):
     # type: (optparse.OptionParser, str) ->  optparse.OptionGroup
     logging.warning("""zulip.generate_option_group is based on optparse, which