Merge "tests: Prefer assertSame() when comparing the integer 0"

[lhc/web/wiklou.git] / tests / selenium / wdio-mediawiki / README.md

diff --git a/tests/selenium/wdio-mediawiki/README.md b/tests/selenium/wdio-mediawiki/README.md
index 260dc77..d2698f7 100644 (file)
--- a/tests/selenium/wdio-mediawiki/README.md
+++ b/tests/selenium/wdio-mediawiki/README.md
@@ -8,7 +8,7 @@ A plugin for [WebdriverIO](http://webdriver.io/) providing utilities to simplify
 
 The `Page` class is a base class for following the [Page Objects Pattern](http://webdriver.io/guide/testrunner/pageobjects.html).
 
-* `openTitle( title [, Object query ] )`
+* `openTitle( title [, Object query [, string fragment ] ] )`
 
 The convention is for implementations to extend this class and provide an `open()` method
 that calls `super.openTitle()`, as well as add various getters for elements on the page.
@@ -22,9 +22,24 @@ Utilities to interact with the MediaWiki API. Uses the [mwbot](https://github.co
 Actions are performed logged-in using `browser.options.username` and `browser.options.password`,
 which typically come from `MEDIAWIKI_USER` and `MEDIAWIKI_PASSWORD` environment variables.
 
-* `edit(title, content)`
-* `delete(title, reason)`
-* `createAccount(username, password)`
+* `edit(string title, string content [, string username [, string password [, string baseUrl ] ] ])`
+* `delete(string title, string reason)`
+* `createAccount(string username, string password)`
+* `blockUser([ string username [, string expiry ] ])`
+* `unblockUser([ string username ])`
+* `bot([string username [, string password [, string baseUrl ] ] ])`
+
+### RunJobs
+
+Use the static `RunJobs.run()` method to ensure that any queued jobs are executed before
+making assertions that depend on its outcome.
+
+### Util
+
+`Util` is a collection of popular utility methods.
+
+* `getTestString([ string prefix ])`
+* `waitForModuleState(string moduleName [, string moduleStatus [, number timeout ] ])`
 
 ## Versioning