Repository navigation
Cleanup and enhance keyword documentation #925
Description
Issue #924 covered enhancing generic library documentation. Similar problems as described in it also in the actual keyword docs. Would be great to go through them too before SL 3.0 final.
Activity
pekkaklarck commentedon Sep 26, 2017
Part of this issue is going through open issue related to documentation and see can they be fixed at the same time.
Clean up docs and messages of browser management kws.
Browser management doc and message update (#952)
Quite big cleanup commit.
Mega super hyper cleanup (#956)
Documented cleaned up Select Window.
Cleanup selecting windows. (#968)
pekkaklarck commentedon Nov 5, 2017
This issue has taken ages to get done because there are so many keywords and some of their docs require a total rewrite. There have also been several nasty surprises with functionality, requiring us to do fixes such as #933, #966, #923, #958 and #942. I hope we've uncovered most of these surprises and it doesn't take too much time to finish this.
Below is a list of files under
src/SeleniumLibrary/keywords/with files already cleaned up marked:alert.pybrowsermanagement.pycookie.pyelement.pyformelement.py(PR More documentation cleanup #984)frames.pyjavascript.py(PR More documentation cleanup #984)runonfailure.py(PR More documentation cleanup #984)screenshot.py(PR Screenshot fixes #986)selectelement.py(PR Fixes and cleanup to list related keywords #989)tableelement.py(PR Table cleanup #992)waiting.py(PR More documentation cleanup #984)window.pyCleanup docs related to form elements.
1 remaining item
Wait kw doc cleanup robotframework#925
Cleanuo run on failure docs (robotframework#925).
Code cleanup to table related keywords.
Clean up table keyword docs. robotframework#925
pekkaklarck commentedon Nov 8, 2017
Issue #188 proposed adding examples to
Wait For Condition. Sounds like a good idea to me but I don't have any good examples in my mind. Any ideas @aaltat or others?pekkaklarck commentedon Nov 8, 2017
All keyword docs have now been reviewed and cleaned up, but not all PRs with the changes (see my comment above) have yet been merged. Once they are, we need to still regenerate the docs and see there are no obvious problems. Otherwise this issue is about to be done.
Table cleanup (#992)
Cleanup docs related to form elements.
Cleanup javascript kw docs (and helper code) #925
Wait kw doc cleanup #925
Cleanuo run on failure docs (#925).
Add examples to Wait For Condition.
pekkaklarck commentedon Nov 9, 2017
This issue is finally about to be ready. Still need to review the generated docs and fix possible problems. The docs can be found from http://robotframework.org/SeleniumLibrary/SeleniumLibrary.html
aaltat commentedon Nov 14, 2017
The documentation looks OK for me. Closing the issue.