Merge pull request #14 from chamberflag/feature/docs

Regenerate docs with yard

doc/Echosign.html

@@ -109,7 +109,7 @@ <h2>
         <dt id="VERSION-constant" class="">VERSION =
 
         </dt>
-        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1.0.2</span><span class='tstring_end'>&quot;</span></span></pre></dd>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1.5.0</span><span class='tstring_end'>&quot;</span></span></pre></dd>
 
     </dl>
 
@@ -125,7 +125,7 @@ <h2>
 </div>
 
       <div id="footer">
-  Generated on Fri Sep  7 16:13:45 2018 by
+  Generated on Thu Oct 18 12:44:43 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.16 (ruby-2.6.0).
 </div>

doc/Echosign/Agreement.html

@@ -337,8 +337,10 @@ <h3 class="signature first" id="initialize-instance_method">
 <p>A list of one or more recipients. For regular (non-MegaSign) documents,
 there is no limit on the number of electronic signatures in a single
 document. Written signatures are limited to four per document. This limit
-includes the sender if the sender&#39;s signature is also required. 
-Populate the array with instances of <span class='object_link'><a href="Recipient.html" title="Echosign::Recipient (class)">Echosign::Recipient</a></span> (REQUIRED)</p>
+includes the sender if the sender&#39;s signature is also required.</p>
+
+<pre class="code ruby"><code class="ruby">Populate the array with instances of {Echosign::Recipient Echosign::Recipient} (REQUIRED)
+</code></pre>
 </div>
 
         </li>
@@ -401,27 +403,27 @@ <h3 class="signature first" id="initialize-instance_method">
       <pre class="lines">
 
 
-25
-26
-27
-28
-29
-30
-31
-32
-33
-34
-35
 36
-37</pre>
+37
+38
+39
+40
+41
+42
+43
+44
+45
+46
+47
+48</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/echosign/agreement.rb', line 25</span>
+      <pre class="code"><span class="info file"># File 'lib/echosign/agreement.rb', line 36</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_user_id'>user_id</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_user_email'>user_email</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_user_id'>user_id</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_user_email'>user_email</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
   <span class='ivar'>@user_id</span> <span class='op'>=</span> <span class='id identifier rubyid_user_id'>user_id</span>
   <span class='ivar'>@user_email</span> <span class='op'>=</span> <span class='id identifier rubyid_user_email'>user_email</span>
-  <span class='comment'>#TODO (cthomas) barf if user_id or user_email are blank
+  <span class='comment'># TODO (cthomas) barf if user_id or user_email are blank
 </span>  <span class='kw'>if</span> <span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_has_key?'>has_key?</span><span class='lparen'>(</span><span class='symbol'>:recipients</span><span class='rparen'>)</span>
     <span class='id identifier rubyid_warn'>warn</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>NOTE: :recipients param in </span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='embexpr_end'>}</span><span class='tstring_content'>.new is deprecated; use :recipientSetInfos instead.\n</span><span class='tstring_end'>&quot;</span></span> <span class='op'>+</span>
          <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='embexpr_end'>}</span><span class='tstring_content'>.new called from </span><span class='embexpr_beg'>#{</span><span class='const'>Gem</span><span class='period'>.</span><span class='id identifier rubyid_location_of_caller'>location_of_caller</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>:</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
@@ -469,12 +471,12 @@ <h3 class="signature first" id="user_email-instance_method">
       <pre class="lines">
 
 
+11
 12
-13
-14</pre>
+13</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/echosign/agreement.rb', line 12</span>
+      <pre class="code"><span class="info file"># File 'lib/echosign/agreement.rb', line 11</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_user_email'>user_email</span>
   <span class='ivar'>@user_email</span>
@@ -512,12 +514,12 @@ <h3 class="signature " id="user_id-instance_method">
       <pre class="lines">
 
 
+11
 12
-13
-14</pre>
+13</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/echosign/agreement.rb', line 12</span>
+      <pre class="code"><span class="info file"># File 'lib/echosign/agreement.rb', line 11</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_user_id'>user_id</span>
   <span class='ivar'>@user_id</span>
@@ -533,7 +535,7 @@ <h3 class="signature " id="user_id-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Fri Sep  7 16:13:50 2018 by
+  Generated on Thu Oct 18 12:44:49 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.16 (ruby-2.6.0).
 </div>