wdio-mediawiki: update signatures in README.md
authorLucas Werkmeister <lucas.werkmeister@wikimedia.de>
Tue, 17 Sep 2019 16:03:38 +0000 (18:03 +0200)
committerLucas Werkmeister <lucas.werkmeister@wikimedia.de>
Tue, 17 Sep 2019 16:03:38 +0000 (18:03 +0200)
Add parameter types everywhere, and mark the parameters of blockUser and
unblockUser as optional.

Change-Id: I4713fed9f073801333796d974fff9d2d7059d1f0

tests/selenium/wdio-mediawiki/README.md

index dc16e81..357fbd9 100644 (file)
@@ -22,11 +22,11 @@ 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 [, string username [, string password [, string baseUrl ] ] ])`
-* `delete(title, reason)`
-* `createAccount(username, password)`
-* `blockUser(username, expiry)`
-* `unblockUser(username)`
+* `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 ])`
 
 ### RunJobs