Improve help docs for the "--variables" option

seleniumbase · Jun 30, 2022 · 94ba70b · 94ba70b
1 parent 05416e0
commit 94ba70b
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 2 deletions.
diff --git a/seleniumbase/plugins/base_plugin.py b/seleniumbase/plugins/base_plugin.py
@@ -92,7 +92,16 @@ def options(self, parser, env):
             "--variables",
             dest="variables",
             default=None,
-            help="A var dict to pass to tests from the command line.",
+            help="""A var dict to pass to tests from the command line.
+                    Example usage:
+                    ----------------------------------------------
+                    Option: --variables='{"special":123}'
+                    Access: self.variables["special"]
+                    ----------------------------------------------
+                    Option: --variables='{"color":"red","num":42}'
+                    Access: self.variables["color"]
+                    Access: self.variables["num"]
+                    ----------------------------------------------""",
         )
         parser.add_option(
             "--settings_file",

diff --git a/seleniumbase/plugins/pytest_plugin.py b/seleniumbase/plugins/pytest_plugin.py
@@ -230,7 +230,16 @@ def pytest_addoption(parser):
         "--variables",
         dest="variables",
         default=None,
-        help="A var dict to pass to tests from the command line.",
+        help="""A var dict to pass to tests from the command line.
+                Example usage:
+                ----------------------------------------------
+                Option: --variables='{"special":123}'
+                Access: self.variables["special"]  # (123)
+                ----------------------------------------------
+                Option: --variables='{"color":"red","num":42}'
+                Access: self.variables["color"]  # ("red")
+                Access: self.variables["num"]  # (42)
+                ----------------------------------------------""",
     )
     parser.addoption(
         "--cap_file",