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

Suggestion for clarifying documentation around Timeouts #1738

Closed
emanlove opened this issue Aug 14, 2021 · 2 comments · Fixed by #1740
Closed

Suggestion for clarifying documentation around Timeouts #1738

emanlove opened this issue Aug 14, 2021 · 2 comments · Fixed by #1740
Labels
acknowledge To be acknowledged in release notes enhancement priority: high
Milestone

Comments

@emanlove
Copy link
Member

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.

@aaltat
Copy link
Contributor

aaltat commented Aug 14, 2021

I like it, how about PR?

@emanlove
Copy link
Member Author

Working on one now .. need to review Contributing docs to see what I need to do to submit a "complete" pull request.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
acknowledge To be acknowledged in release notes enhancement priority: high
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants