Skip to content

More documentation cleanup #984

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.

Sign up for GitHub

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

Merged
aaltat merged 5 commits into from
Nov 8, 2017
Merged

More documentation cleanup #984

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3ebb039
Cleanup docs related to form elements.
pekkaklarck Nov 5, 2017
ff9e6a1
Cleanup javascript kw docs (and helper code) #925
pekkaklarck Nov 5, 2017
a1ecf0e
Wait kw doc cleanup #925
pekkaklarck Nov 5, 2017
569e080
Cleanuo run on failure docs (#925).
pekkaklarck Nov 5, 2017
550ebaa
Mention that password is logged on levels below INFO
pekkaklarck Nov 6, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/SeleniumLibrary/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,10 +82,10 @@ class SeleniumLibrary(DynamicCore):

By default locators are considered to use the keyword specific default
locator strategy. All keywords support finding elements based on ``id``
and ``name`` attributes, but some keywords support additional _key
attributes_ that make sense in their context. For example, `Click Link`
supports the link text and the ``href`` attribute in addition to the
normal ``id`` and ``name``.
and ``name`` attributes, but some keywords support additional attributes
or other values that make sense in their context. For example, `Click
Link` supports the ``href`` attribute and the link text and addition
to the normal ``id`` and ``name``.

Examples:

Expand Down
28 changes: 16 additions & 12 deletions src/SeleniumLibrary/keywords/element.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -609,8 +609,8 @@ def click_link(self, locator):
"""Clicks a link identified by ``locator``.

See the `Locating elements` section for details about the locator
syntax. Key attributes for links are ``id``, ``name``, ``href`` and
link text.
syntax. When using the default locator strategy, links are searched
using ``id``, ``name``, ``href`` and the link text.
"""
self.info("Clicking link '%s'." % locator)
self.find_element(locator, tag='link').click()
Expand All @@ -629,8 +629,8 @@ def mouse_down_on_link(self, locator):
"""Simulates a mouse down event on a link identified by ``locator``.

See the `Locating elements` section for details about the locator
syntax. Key attributes for links are ``id``, ``name``, ``href`` and
link text.
syntax. When using the default locator strategy, links are searched
using ``id``, ``name``, ``href`` and the link text.
"""
element = self.find_element(locator, tag='link')
action = ActionChains(self.browser)
Expand All @@ -641,8 +641,8 @@ def page_should_contain_link(self, locator, message=None, loglevel='INFO'):
"""Verifies link identified by ``locator`` is found from current page.

See the `Locating elements` section for details about the locator
syntax. Key attributes for links are ``id``, ``name``, ``href`` and
link text.
syntax. When using the default locator strategy, links are searched
using ``id``, ``name``, ``href`` and the link text.

See `Page Should Contain Element` for explanation about ``message``
and ``loglevel`` arguments.
Expand All @@ -654,8 +654,8 @@ def page_should_not_contain_link(self, locator, message=None, loglevel='INFO'):
"""Verifies link identified by ``locator`` is not found from current page.

See the `Locating elements` section for details about the locator
syntax. Key attributes for links are ``id``, ``name``, ``href`` and
link text.
syntax. When using the default locator strategy, links are searched
using ``id``, ``name``, ``href`` and the link text.

See `Page Should Contain Element` for explanation about ``message``
and ``loglevel`` arguments.
Expand All @@ -667,7 +667,8 @@ def click_image(self, locator):
"""Clicks an image identified by ``locator``.

See the `Locating elements` section for details about the locator
syntax. Key attributes for images are ``id``, ``src`` and ``alt``.
syntax. When using the default locator strategy, images are searched
using ``id``, ``name``, ``src`` and ``alt``.
"""
self.info("Clicking image '%s'." % locator)
element = self.find_element(locator, tag='image', required=False)
Expand All @@ -681,7 +682,8 @@ def mouse_down_on_image(self, locator):
"""Simulates a mouse down event on an image identified by ``locator``.

See the `Locating elements` section for details about the locator
syntax. Key attributes for images are ``id``, ``src`` and ``alt``.
syntax. When using the default locator strategy, images are searched
using ``id``, ``name``, ``src`` and ``alt``.
"""
element = self.find_element(locator, tag='image')
action = ActionChains(self.browser)
Expand All @@ -692,7 +694,8 @@ def page_should_contain_image(self, locator, message=None, loglevel='INFO'):
"""Verifies image identified by ``locator`` is found from current page.

See the `Locating elements` section for details about the locator
syntax. Key attributes for images are ``id``, ``src`` and ``alt``.
syntax. When using the default locator strategy, images are searched
using ``id``, ``name``, ``src`` and ``alt``.

See `Page Should Contain Element` for explanation about ``message``
and ``loglevel`` arguments.
Expand All @@ -704,7 +707,8 @@ def page_should_not_contain_image(self, locator, message=None, loglevel='INFO'):
"""Verifies image identified by ``locator`` is found from current page.

See the `Locating elements` section for details about the locator
syntax. Key attributes for images are ``id``, ``src`` and ``alt``.
syntax. When using the default locator strategy, images are searched
using ``id``, ``name``, ``src`` and ``alt``.

See `Page Should Contain Element` for explanation about ``message``
and ``loglevel`` arguments.
Expand Down
Loading