Adds sphix style definitions to important methods. #994
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pekkaklarck
reviewed
Nov 10, 2017
src/SeleniumLibrary/__init__.py
Outdated
| :param driver: Instance of the Selenium `WebDriver`. | ||
| :param alias: Alias given for this `WebDriver` instance. | ||
| :type driver: selenium.webdriver.remote.webdriver.WebDriver | ||
| :type alias: intger or string |
Member
There was a problem hiding this comment.
- I'd prefer having
:typeright after the matching:param. - Type of alias seems wrong in many ways. Should it be a class, not free text? There's a typo. And alias actually is always a string.
- Do we need to specify the type for all arguments, including strings? I noticed you hadn't added types to such arguments in other places and I think that's OK.
pekkaklarck
reviewed
Nov 10, 2017
src/SeleniumLibrary/__init__.py
Outdated
| :param parent: Optional parent `WebElememt` to search child elements | ||
| from. By default search starts from the root using `WebDriver`. | ||
| :type parent: selenium.webdriver.remote.webelement.WebElement | ||
| :return: list of found `WebElement` or `[]` if element not found. |
Member
There was a problem hiding this comment.
This isn't too clear. Wouldn't just List of found elements. be enough when the type specified explicitly below. If you want to explain the list can be empty (which ought to be pretty obvious), something like If no matching elements are found, the list is empty. could be added as well.
pekkaklarck
reviewed
Nov 10, 2017
src/SeleniumLibrary/__init__.py
Outdated
| Always returns a list of `WebElement` objects. If no matching element | ||
| is found, the list is empty. Otherwise semantics are exactly same | ||
| as with :meth:`find_element`. |
Member
There was a problem hiding this comment.
This is duplicate information now that arguments are explained above and can be removed.
pekkaklarck
reviewed
Nov 10, 2017
src/SeleniumLibrary/base/context.py
Outdated
| :param parent: Optional parent `WebElememt` to search child elements | ||
| from. By default search starts from the root using `WebDriver`. | ||
| :type parent: selenium.webdriver.remote.webelement.WebElement | ||
| :return: list of found `WebElement` or `[]` if element not found. |
Member
There was a problem hiding this comment.
Also this explanation can be enhanced and the paragraph below containing duplicate information removed.
aaltat
force-pushed
the
update_sphix_type_definitions
branch
from
1e5507b to
fb963b0
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Part of #882