diff --git a/src/SeleniumLibrary/__init__.py b/src/SeleniumLibrary/__init__.py index c603d38a0..5754cb0f0 100644 --- a/src/SeleniumLibrary/__init__.py +++ b/src/SeleniumLibrary/__init__.py @@ -356,7 +356,8 @@ class SeleniumLibrary(DynamicCore): See `time format` below for supported syntax. == Page load == - Page load timeout is the amount of time to wait for page load to complete until error is raised. + Page load timeout is the amount of time to wait for page load to complete + until a timeout exception is raised. The default page load timeout can be set globally when `importing` the library with the ``page_load_timeout`` argument @@ -467,7 +468,7 @@ def __init__( Class for wrapping Selenium with [https://seleniumhq.github.io/selenium/docs/api/py/webdriver_support/selenium.webdriver.support.event_firing_webdriver.html#module-selenium.webdriver.support.event_firing_webdriver|EventFiringWebDriver] - ``page_load_timeout``: - Default value to wait for page load to complete until error is raised. + Default value to wait for page load to complete until a timeout exception is raised. - ``action_chain_delay``: Default value for `ActionChains` delay to wait in between actions. """ diff --git a/src/SeleniumLibrary/keywords/browsermanagement.py b/src/SeleniumLibrary/keywords/browsermanagement.py index 4eb2fdd0d..016f42a1e 100644 --- a/src/SeleniumLibrary/keywords/browsermanagement.py +++ b/src/SeleniumLibrary/keywords/browsermanagement.py @@ -614,8 +614,8 @@ def get_selenium_implicit_wait(self) -> str: @keyword def get_selenium_page_load_timeout(self) -> str: - """Gets the timeout to wait for a page load to complete - before throwing an error. + """Gets the time to wait for a page load to complete + before raising a timeout exception. The value is returned as a human-readable string like ``1 second``. @@ -733,9 +733,9 @@ def set_selenium_page_load_timeout(self, value: timedelta) -> str: The previous value is returned and can be used to restore the original value later if needed. - In contrast to `Set Selenium Timeout` and `Set Selenium Implicit Wait` - this keywords sets the time for Webdriver to wait until page - is loaded before throwing an error. + In contrast to `Set Selenium Timeout` and `Set Selenium Implicit Wait`, + this keywords sets the time for the Webdriver to wait until the page + is loaded before raising a timeout exception. See the `Page load` section above for more information. diff --git a/utest/test/api/approved_files/PluginDocumentation.test_many_plugins.approved.txt b/utest/test/api/approved_files/PluginDocumentation.test_many_plugins.approved.txt index ffaa13588..391a5a73e 100644 --- a/utest/test/api/approved_files/PluginDocumentation.test_many_plugins.approved.txt +++ b/utest/test/api/approved_files/PluginDocumentation.test_many_plugins.approved.txt @@ -299,7 +299,8 @@ Selenium documentation] for more information about this functionality. See `time format` below for supported syntax. == Page load == -Page load timeout is the amount of time to wait for page load to complete until error is raised. +Page load timeout is the amount of time to wait for page load to complete +until a timeout exception is raised. The default page load timeout can be set globally when `importing` the library with the ``page_load_timeout`` argument diff --git a/utest/test/api/approved_files/PluginDocumentation.test_parse_plugin_init_doc.approved.txt b/utest/test/api/approved_files/PluginDocumentation.test_parse_plugin_init_doc.approved.txt index e45c06ff3..db0eb9db6 100644 --- a/utest/test/api/approved_files/PluginDocumentation.test_parse_plugin_init_doc.approved.txt +++ b/utest/test/api/approved_files/PluginDocumentation.test_parse_plugin_init_doc.approved.txt @@ -16,6 +16,6 @@ SeleniumLibrary can be imported with several optional arguments. Class for wrapping Selenium with [https://seleniumhq.github.io/selenium/docs/api/py/webdriver_support/selenium.webdriver.support.event_firing_webdriver.html#module-selenium.webdriver.support.event_firing_webdriver|EventFiringWebDriver] - ``page_load_timeout``: - Default value to wait for page load to complete until error is raised. + Default value to wait for page load to complete until a timeout exception is raised. - ``action_chain_delay``: Default value for `ActionChains` delay to wait in between actions.