Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation on page load timeout #1821

Merged
merged 1 commit into from
Nov 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions src/SeleniumLibrary/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
"""
Expand Down
10 changes: 5 additions & 5 deletions src/SeleniumLibrary/keywords/browsermanagement.py
Original file line number Diff line number Diff line change
Expand Up @@ -626,8 +626,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``.

Expand Down Expand Up @@ -745,9 +745,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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.