Repository navigation
Libdoc updates - link to project and fix 404 - #668
Conversation
pekkaklarck
left a comment
pekkaklarck
left a comment
There was a problem hiding this comment.
Good enhancements. Please see my line notes for few things that could be enhanced.
| document is about using Selenium2Library. For information about | ||
| installation, support, and more please visit the | ||
| [https://github.com/robotframework/Selenium2Library|project page]. | ||
|
|
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
| 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]. |
There was a problem hiding this comment.
Good catch! Also good idea to use the link format supported by Libdoc nowadays. The leading extra spaces (or is that a tab?) should be removed, though, and the last line aligned same way as the previous one.
There was a problem hiding this comment.
I dunno how that happened but I will fix it. and will work on keeping my multiple github accounts straight :)
|
From my mobile screen all looks OK, but have to look from a bigger screen, because last time I did missed the line 137 problem from the mobile screen. |
|
New laptop. Did not realize I was using tabs instead of 4 spaces. Silly me. Hope to contribute more meaningfully again in the future. This PR was just getting my feet wet after being out of the pool for so long. @pekkaklarck or other contributors please try the squash during merge feature - great addition to GitHub. @pekkaklarck thanks again for your attention to detail. In then end it really pays off as it is all to easy to build up technical debt. |
|
Thanks for the PR @ombre42 and looking forward for more! Tabs/spaces issues occur very easily unless you configure the editor to always use spaces (or the editor does that by default). Luckily Python 3 is more strict about mixing tabs/spaces and such errors cannot occur anymore with it. Python 2 also has The new squashing functionality on GitHub is great. @aaltat, please merge the PR once you had a chance to look at it on a bigger screen. |
* Fix 404 due to RF migration to Github * Link to project page * Format corrections per PR comments * fix pronoun usage
* Fix 404 due to RF migration to Github * Link to project page * Format corrections per PR comments * fix pronoun usage
* Fix 404 due to RF migration to Github * Link to project page * Format corrections per PR comments * fix pronoun usage
There are entries obsolete or overridden by others. The goal is to keep Selenium2Library compatible with Python 2.7 and 3.x. There is still discussion on the best way to solve compatability problems, like for example, 'unicode'. See https://github.com/robotframework/Selenium2Library/pull/720 for more info on this. Commits entries: Changes to Travis settings to allow installation dependent on Python versions. Transformed print statement into function. Compatible with Python 2.6. Fixes import to be compatible with RobotFramework 3.0. Changes Travis settings to install RobotFramework 3.0. Separates imports per line, for better code readability. Adds 'future' dependency and information to install it. Upgrades Travis firefox to latest-esr. Fixes ez_setup.py. Changes version to 1.8.0b2. Removes selenium version dependency, current version is 2.53.2. Add GitHub process files. Update CONTRIBUTING.md Fixed Issues URL to point to my fork. Update ISSUE_TEMPLATE.md Fix typo Libdoc updates - link to project and fix 404 (robotframework#668) * Fix 404 due to RF migration to Github * Link to project page * Format corrections per PR comments * fix pronoun usage Added method to find element by class name robotframework#673 (robotframework#674) * Added method to find element by class name robotframework#673 * Changes to use Firefox ESR (45.4.0) While we are not having Selenium 3.0 working, with external `geckodriver`, we use lower versions of stable Firefox. * Changes to use Selenium 2.53.6 (and not 3.0) We are not ready for Selenium 3.0 yet. Updated Travis config. Fixes installer for both Python 2.7 and 3.x.
The first hit on the U.S. English Google is to the libdoc, which is a dead end. So I thought it would be good to link to the project page. Also I found a 404 on the user guide caused by RF migrating to GitHub.