From 62fe9ccd80c97c0f72f1509637eacdb5d60486d1 Mon Sep 17 00:00:00 2001
From: Dave Hunt <dave.hunt@gmail.com>
Date: Mon, 13 Feb 2017 14:05:44 +0000
Subject: [PATCH] Added documentation for ircNotification and writeCapabilities
 steps

---
 vars/ircNotification.txt   |  9 +++++++++
 vars/writeCapabilities.txt | 11 +++++++++++
 2 files changed, 20 insertions(+)
 create mode 100644 vars/ircNotification.txt
 create mode 100644 vars/writeCapabilities.txt

diff --git a/vars/ircNotification.txt b/vars/ircNotification.txt
new file mode 100644
index 0000000..d302ec9
--- /dev/null
+++ b/vars/ircNotification.txt
@@ -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>
diff --git a/vars/writeCapabilities.txt b/vars/writeCapabilities.txt
new file mode 100644
index 0000000..0a9e130
--- /dev/null
+++ b/vars/writeCapabilities.txt
@@ -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>