Skip to content

Suggestion for clarifying documentation around Timeouts #1738

@emanlove

Description

@emanlove

Dave Martin and I were discussing some wording and understanding about timeouts. He has the following suggestions for some clarifying sentences to the documentation to make clear (changes in bold).

SeleniumLibrary contains various keywords that have an optional timeout argument that specifies how long these keywords should wait for certain events or actions. These keywords include, for example, Wait ... keywords and keywords related to alerts. Additionally Execute Async Javascript. Although it does not have timeout, argument, uses a timeout to define how long asynchronous JavaScript can run.

The default timeout these keywords use can be set globally either by using the Set Selenium Timeout keyword or with the timeout argument when importing the library. If no default timeout is set globally, the default is 5 seconds. If None is specified for the timeout argument in the keywords, the default is used. See time format below for supported timeout syntax.

I am temporarily recording/storing his suggestion here as to not lose it out of Slack. I'll submit a pull request sometime in the future.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions