MarketSquare / MarketSquare/robotframework-browser

Documentation for Assertion "contains" unclear

Open
#3,640 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug priority: high
Dominant language
Python
Stars
655
Forks
147
Avg merge
5h 27m
Merged PRs (30d)
59

Description

Regarding the docs for `Get Element States`, especially this line:

`Get Element States id=disabled_elem contains visible disabled readonly`

The documentation of assertion operators is unclear for me because the **keyword returns a list**, `contains` however is explained as “_Checks if returned value contains expected value as substring._“.

This explanation leaves open whether the list is flattened as a string or if contains works different when it gets a list instead of a string to search in.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Get Element States documentation and its assertion-operator explanation. Check the behavior of contains when the returned value is a list, then clarify the docs with wording or an example that resolves whether matching is element-based or uses a flattened string.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, testing-qa
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.