Add note that GitHub example fails if 2FA enabled

Closes #327, closes #328.
MechanicalSoup · Nov 2, 2020 · 5dc6008 · 5dc6008
1 parent 0a5e179
commit 5dc6008
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/examples/example.py b/examples/example.py
@@ -1,4 +1,6 @@
-"""Example app to login to GitHub using the StatefulBrowser class."""
+"""Example app to login to GitHub using the StatefulBrowser class.
+
+NOTE: This example will not work if the user has 2FA enabled."""
 
 from __future__ import print_function
 import argparse