Added documentation for ircNotification and writeCapabilities steps

This commit is contained in:
Dave Hunt 2017-02-13 14:05:44 +00:00
Родитель fe318362d8
Коммит 62fe9ccd80
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4000D32ABB02F959
2 изменённых файлов: 20 добавлений и 0 удалений

9
vars/ircNotification.txt Normal file
Просмотреть файл

@ -0,0 +1,9 @@
<p>Sends a notice to IRC with the current build result.</p>
<dl>
<dt>ircNotification([server, nick, channel])</dt>
<dd>
Sends a notification to IRC with the specified <code>server</code>,
<code>nick</code>, and <code>channel</code>. By default it will connect to
<code>irc.mozilla.org:6697</code> as <code>fxtest</code> and join the
<code>#fx-test-alerts</code> channel.
</dl>

Просмотреть файл

@ -0,0 +1,11 @@
<p>Write desired capabilities to a JSON file.</p>
<dl>
<dt>writeCapabilities(capabilities, [path])</dt>
<dd>
Writes a JSON file containing the items from the <code>capabilities</code>
map to the specified <code>path</code> (for use by
<a href="http://pytest-selenium.readthedocs.io/en/latest/user_guide.html#capabilities-files">
pytest-selenium</a>). If omitted, the <code>path</code> defaults to
<code>capabilities.json</code> in the working directory.
</dd>
</dl>