MarketSquare / MarketSquare/robotframework-browser
Enhance documentation for assertion timeout
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 655
- Forks
- 147
- Avg merge
- 5h 27m
- Merged PRs (30d)
- 59
Description
Documentation for assertion timeout and browser timeout shall be enhanced to make clear, that maximum timeout actually used is alway the browser timeout.
E.g.
- browser timeout is 5s and assertion timeout is 10s.
- Browser.Get Text my_selector == expected text
will fail after 5s also, if element identified by my_selector is visible but different from expected text
It does not make sense to set the assertion timeout to a higher value than browser timeout, since this will never take effect.
I suggest to add an appropritate log message (warning) in this case.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No file or test path is named. Start by locating the documentation for assertion and browser timeouts, then find the timeout-handling and logging entry points. Done means the documentation explains that the browser timeout is the maximum effective timeout, includes the example, and the proposed warning is addressed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- playwright, python
- Domain
- documentation, testing
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100