Applied requested docs changes

ethan7g · Jun 4, 2019 · 3dad3d1 · 3dad3d1
1 parent 2655fc7
commit 3dad3d1
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 9 deletions.
diff --git a/docs/global.html b/docs/global.html
@@ -565,7 +565,7 @@ <h5 class="subsection-title">Properties:</h5>
                 </td>
 
 
-            <td class="description last">Response parsing. Errors will be given if the repsonse can't be parsed. ('none', 'json')</td>
+            <td class="description last">Response parsing. Errors will be given if the response can't be parsed. ('none', 'json')</td>
         </tr>
 
 
@@ -1084,7 +1084,7 @@ <h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.htm
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jan 15 2019 19:22:29 GMT-0800 (STD)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Jun 03 2019 19:40:29 GMT-0700 (Pacific Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/index.html b/docs/index.html
@@ -65,7 +65,7 @@ <h2>Quick Demos</h2><p>Simple POST:</p>
     data: {
         hey: 'hi'
     }
-})</code></pre><h2>Unpromisified Usage</h2><pre class="prettyprint source lang-js"><code>const p = require('phin').unpromisified
+})</code></pre><h3>Unpromisified Usage</h3><pre class="prettyprint source lang-js"><code>const p = require('phin').unpromisified
 
 p('https://ethanent.me', (err, res) => {
     if (!err) console.log(res.body)
@@ -77,7 +77,7 @@ <h2>Quick Demos</h2><p>Simple POST:</p>
     'parse': 'json'
 })
 
-console.log(res.body.first)</code></pre><h2>Default Options</h2><pre class="prettyprint source lang-js"><code>const ppostjson = p.defaults({
+console.log(res.body.first)</code></pre><h3>Default Options</h3><pre class="prettyprint source lang-js"><code>const ppostjson = p.defaults({
     'method': 'POST',
     'parse': 'json',
     'timeout': 2000
@@ -88,7 +88,7 @@ <h2>Quick Demos</h2><p>Simple POST:</p>
 const res = await ppostjson('https://ethanent.me/somejson')
 // ^ An options object could also be used here to set other options.
 
-// Do things with res.body?</code></pre><h2>Custom Core HTTP Options</h2><p>phin allows you to set <a href="https://nodejs.org/api/http.html#http_http_request_url_options_callback">core HTTP options</a>.</p>
+// Do things with res.body?</code></pre><h3>Custom Core HTTP Options</h3><p>phin allows you to set <a href="https://nodejs.org/api/http.html#http_http_request_url_options_callback">core HTTP options</a>.</p>
 <pre class="prettyprint source lang-js"><code>await p({
     'url': 'https://ethanent.me/name',
     'core': {
@@ -160,7 +160,7 @@ <h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.htm
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jan 15 2019 19:22:29 GMT-0800 (STD)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Jun 03 2019 19:40:29 GMT-0700 (Pacific Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/phin.js.html b/docs/phin.js.html
@@ -39,7 +39,7 @@ <h1 class="page-title">Source: phin.js</h1>
 * @property {Object} [form] - Object to send as form data (sets 'Content-Type' and 'Content-Length' headers, as well as request body) (overwrites 'data' option if present)
 * @property {Object} [headers={}] - Request headers
 * @property {Object} [core={}] - Custom core HTTP options
-* @property {string} [parse=none] - Response parsing. Errors will be given if the repsonse can't be parsed. ('none', 'json')
+* @property {string} [parse=none] - Response parsing. Errors will be given if the response can't be parsed. ('none', 'json')
 * @property {boolean} [followRedirects=false] - Enable HTTP redirect following
 * @property {boolean} [stream=false] - Enable streaming of response. (Removes body property)
 * @property {boolean} [compression=false] - Enable compression for request
@@ -124,7 +124,8 @@ <h1 class="page-title">Source: phin.js</h1>
 
 phin.defaults = (defaultOpts) => async (opts) => await phin(Object.assign(defaultOpts, typeof opts === 'string' ? {'url': opts} : opts))
 
-module.exports = phin</code></pre>
+module.exports = phin
+</code></pre>
         </article>
     </section>
 
@@ -140,7 +141,7 @@ <h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.htm
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jan 15 2019 19:22:29 GMT-0800 (STD)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Jun 03 2019 19:40:29 GMT-0700 (Pacific Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>