From cd89abefaf72312131dcad60362c12fde2947e0c Mon Sep 17 00:00:00 2001 From: Michael Mintz Date: Mon, 12 Oct 2020 09:46:06 -0400 Subject: [PATCH] Update the docs --- README.md | 2 +- help_docs/customizing_test_runs.md | 2 +- seleniumbase/plugins/base_plugin.py | 4 ++-- seleniumbase/plugins/pytest_plugin.py | 2 +- seleniumbase/plugins/selenium_plugin.py | 4 ++-- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index febec5fb..68cababa 100755 --- a/README.md +++ b/README.md @@ -405,7 +405,7 @@ SeleniumBase provides additional ``pytest`` command-line options for tests: --locale=LOCALE_CODE # (Set the Language Locale Code for the web browser.) --start-page=URL # (The starting URL for the web browser when tests begin.) --archive-logs # (Archive old log files instead of deleting them.) ---time-limit=SECONDS # (Safely fail any test that exceeds the limit limit.) +--time-limit=SECONDS # (Safely fail any test that exceeds the time limit.) --slow # (Slow down the automation. Faster than using Demo Mode.) --demo # (Slow down and visually see test actions as they occur.) --demo-sleep=SECONDS # (Set the wait time after Demo Mode actions.) diff --git a/help_docs/customizing_test_runs.md b/help_docs/customizing_test_runs.md index dfadfbcc..d973e81f 100755 --- a/help_docs/customizing_test_runs.md +++ b/help_docs/customizing_test_runs.md @@ -116,7 +116,7 @@ SeleniumBase provides additional ``pytest`` command-line options for tests: --locale=LOCALE_CODE # (Set the Language Locale Code for the web browser.) --start-page=URL # (The starting URL for the web browser when tests begin.) --archive-logs # (Archive old log files instead of deleting them.) ---time-limit=SECONDS # (Safely fail any test that exceeds the limit limit.) +--time-limit=SECONDS # (Safely fail any test that exceeds the time limit.) --slow # (Slow down the automation. Faster than using Demo Mode.) --demo # (Slow down and visually see test actions as they occur.) --demo-sleep=SECONDS # (Set the wait time after Demo Mode actions.) diff --git a/seleniumbase/plugins/base_plugin.py b/seleniumbase/plugins/base_plugin.py index 840a3a61..87714fd7 100755 --- a/seleniumbase/plugins/base_plugin.py +++ b/seleniumbase/plugins/base_plugin.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- -""" This is the Nose plugin for setting a test environment and saving logs. """ +""" This is the Nosetest plugin for setting base configuration and logging. """ import sys import time @@ -12,7 +12,7 @@ from seleniumbase.fixtures import constants, errors class Base(Plugin): """ - This parser plugin includes the following command-line options for Nose: + This plugin adds the following command-line options to nosetests: --env=ENV (Set the test env. Access with "self.env" in tests.) --data=DATA (Extra test data. Access with "self.data" in tests.) --var1=DATA (Extra test data. Access with "self.var1" in tests.) diff --git a/seleniumbase/plugins/pytest_plugin.py b/seleniumbase/plugins/pytest_plugin.py index a9d860ce..d730e112 100644 --- a/seleniumbase/plugins/pytest_plugin.py +++ b/seleniumbase/plugins/pytest_plugin.py @@ -37,7 +37,7 @@ def pytest_addoption(parser): --locale=LOCALE_CODE (Set the Language Locale Code for the web browser.) --start-page=URL (The starting URL for the web browser when tests begin.) --archive-logs (Archive old log files instead of deleting them.) - --time-limit=SECONDS (Safely fail any test that exceeds the limit limit.) + --time-limit=SECONDS (Safely fail any test that exceeds the time limit.) --slow (Slow down the automation. Faster than using Demo Mode.) --demo (Slow down and visually see test actions as they occur.) --demo-sleep=SECONDS (Set the wait time after Demo Mode actions.) diff --git a/seleniumbase/plugins/selenium_plugin.py b/seleniumbase/plugins/selenium_plugin.py index f2348254..e58577d4 100755 --- a/seleniumbase/plugins/selenium_plugin.py +++ b/seleniumbase/plugins/selenium_plugin.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- -""" This is the nosetests Selenium plugin for test configuration. """ +""" This is the Nosetest plugin for setting Selenium test configuration. """ import sys from nose.plugins import Plugin @@ -27,7 +27,7 @@ class SeleniumBrowser(Plugin): --headed (Run tests with a GUI on Linux OS.) --locale=LOCALE_CODE (Set the Language Locale Code for the web browser.) --start-page=URL (The starting URL for the web browser when tests begin.) - --time-limit=SECONDS (Safely fail any test that exceeds the limit limit.) + --time-limit=SECONDS (Safely fail any test that exceeds the time limit.) --slow (Slow down the automation. Faster than using Demo Mode.) --demo (Slow down and visually see test actions as they occur.) --demo-sleep=SECONDS (Set the wait time after Demo Mode actions.)