Skip to content

Generic library documentation update - #918

Merged
aaltat merged 6 commits into
robotframework:masterfrom
pekkaklarck:doc-update
Sep 26, 2017
Merged

aaltat merged 6 commits into
robotframework:masterfrom
pekkaklarck:doc-update

Conversation

@pekkaklarck

Copy link
Copy Markdown
Member

Includes explaining the new strategy:value syntax (#908).

Still plan to update the documentation of the __init__, but going through individual keywords is too much work for 3.0.

pekkaklarck and others added 3 commits September 25, 2017 16:06
Includes explaining the new `strategy:value` syntax (robotframework#908).
'implicit_wait'  -> `implicit_wait`
Comment thread src/SeleniumLibrary/__init__.py Outdated

Examples:

| `Click Element` | name:foo | # Find element with class ``foo``. |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thin comment should say:

Find element with name attribute ``foo``

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I changed the example but apparently forget the comment. Will fix.

Comment thread src/SeleniumLibrary/__init__.py Outdated
| `Click Element` | name:foo | # Find element with class ``foo``. |
| `Click Element` | default:name:foo | # Use default strategy with value ``class:foo``. |
| `Click Element` | //foo | # Find element using XPath ``//foo``. |
| `Click Element` | //foo | # Use default strategy with value ``//foo``. |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The locator is same in the above xpath example but the comment says something else, should the locator be just foo without the double forward slashes.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should be default://foo. Will fix.

Comment thread src/SeleniumLibrary/__init__.py Outdated
used by all of them can be set globally using the
`Set Selenium Timeout` keyword. The same timeout also applies to
`Execute Async Javascript`.
used by all of them can be set globally using the `Set Selenium Timeout`

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we also say that timeout can be set in the library import?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea. Will add.

Explain general topics in the general library documentation section,
not in __init__.
@aaltat
aaltat merged commit 50a9861 into robotframework:master Sep 26, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants