Skip to content

Libdoc updates - link to project and fix 404 #668

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 4 commits into from
Oct 9, 2016
Merged

Libdoc updates - link to project and fix 404 #668

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8cd0974
Fix 404 due to RF migration to Github
ombre42 Sep 23, 2016
154e646
Link to project page
ombre42 Sep 23, 2016
87e900a
Format corrections per PR comments
ombre42 Sep 30, 2016
98e9071
fix pronoun usage
ombre42 Sep 30, 2016
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
4 changes: 2 additions & 2 deletions docs/Selenium2Library.html
View file
Open in desktop

Large diffs are not rendered by default.

10 changes: 7 additions & 3 deletions src/Selenium2Library/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,12 @@ class Selenium2Library(
_AlertKeywords
):
"""Selenium2Library is a web testing library for Robot Framework.

This document is about using Selenium2Library. For information about
installation, support, and more please visit the
[https://github.com/robotframework/Selenium2Library|project page].

@pekkaklarck pekkaklarck Sep 23, 2016

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Good idea to add this information, but it should be a separate paragraph indented same amount as other paragraphs. For more details see PEP-257: https://www.python.org/dev/peps/pep-0257/#multi-line-docstrings

@kormbrek-rally kormbrek-rally Sep 28, 2016

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

thanks for the feedback. even though it is docstring, it exists to generate the library documentation, so I did not think about the normal conventions. I will update it.

It uses the Selenium 2 (WebDriver) libraries internally to control a web browser.
Selenium2Library uses the Selenium 2 (WebDriver) libraries internally to control a web browser.
See http://seleniumhq.org/docs/03_webdriver.html for more information on Selenium 2
and WebDriver.

Expand Down Expand Up @@ -130,8 +134,8 @@ class Selenium2Library(

All timeouts can be given as numbers considered seconds (e.g. 0.5 or 42)
or in Robot Framework's time syntax (e.g. '1.5 seconds' or '1 min 30 s').
For more information about the time syntax see:
http://robotframework.googlecode.com/svn/trunk/doc/userguide/RobotFrameworkUserGuide.html#time-format.
For more information about the time syntax see the
[http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#time-format|Robot Framework User Guide].
"""

ROBOT_LIBRARY_SCOPE = 'GLOBAL'
Expand Down