From 59320f6b28736245301a87cbf0ef79502a9d0ac6 Mon Sep 17 00:00:00 2001
From: derAnfaenger <robhoenig@gmail.com>
Date: Thu, 14 Sep 2017 11:37:03 +0200
Subject: [PATCH] zulip: Explain use cases for `generate_option_group()`
 method.

---
 zulip/zulip/__init__.py | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/zulip/zulip/__init__.py b/zulip/zulip/__init__.py
index be474e5..2b4d6fd 100644
--- a/zulip/zulip/__init__.py
+++ b/zulip/zulip/__init__.py
@@ -170,6 +170,10 @@ def add_default_arguments(parser, patch_error_handling=True, allow_provisioning=
                             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