docs: correct drawHorizontalLine reference reference (closes #54)

gajus · Sep 4, 2018 · d160abd · d160abd
1 parent d56164c
commit d160abd
Show file tree

Hide file tree

Showing 7 changed files with 14 additions and 10 deletions.
diff --git a/.README/usage.md b/.README/usage.md
@@ -59,7 +59,7 @@ data = [
  * Used to dynamically tell table whether to draw a line separating rows or not.
  * The default behavior is to always return true.
  *
- * @typedef {function} drawJoin
+ * @typedef {function} drawHorizontalLine
  * @param {number} index
  * @param {number} size
  * @return {boolean}
@@ -70,7 +70,7 @@ data = [
  * @property {table~border} border
  * @property {table~columns[]} columns Column specific configuration.
  * @property {table~columns} columnDefault Default values for all columns. Column specific settings overwrite the default values.
- * @property {table~drawJoin} drawHorizontalLine
+ * @property {table~drawHorizontalLine} drawHorizontalLine
  */
 
 /**

diff --git a/.README/usage/draw_horizontal_line.md b/.README/usage/draw_horizontal_line.md
@@ -17,7 +17,7 @@ data = [
 
 options = {
     /**
-     * @typedef {function} drawJoin
+     * @typedef {function} drawHorizontalLine
      * @param {number} index
      * @param {number} size
      * @return {boolean}
@@ -30,6 +30,7 @@ options = {
 output = table(data, options);
 
 console.log(output);
+
 ```
 
 ```
@@ -42,4 +43,5 @@ console.log(output);
 ╟────┼────┼────╢
 ║ 4A │ 4B │ 4C ║
 ╚════╧════╧════╝
+
 ```
diff --git a/.README/usage/predefined_border_templates.md b/.README/usage/predefined_border_templates.md
@@ -82,7 +82,7 @@ output = table(data, {
         paddingLeft: 0,
         paddingRight: 1
     },
-    drawJoin: () => {
+    drawHorizontalLine: () => {
         return false
     }
 });

diff --git a/README.md b/README.md
@@ -96,7 +96,7 @@ data = [
  * Used to dynamically tell table whether to draw a line separating rows or not.
  * The default behavior is to always return true.
  *
- * @typedef {function} drawJoin
+ * @typedef {function} drawHorizontalLine
  * @param {number} index
  * @param {number} size
  * @return {boolean}
@@ -107,7 +107,7 @@ data = [
  * @property {table~border} border
  * @property {table~columns[]} columns Column specific configuration.
  * @property {table~columns} columnDefault Default values for all columns. Column specific settings overwrite the default values.
- * @property {table~drawJoin} drawHorizontalLine
+ * @property {table~drawHorizontalLine} drawHorizontalLine
  */
 
 /**
@@ -296,7 +296,7 @@ data = [
 
 options = {
     /**
-     * @typedef {function} drawJoin
+     * @typedef {function} drawHorizontalLine
      * @param {number} index
      * @param {number} size
      * @return {boolean}
@@ -309,6 +309,7 @@ options = {
 output = table(data, options);
 
 console.log(output);
+
 ```
 
 ```
@@ -321,6 +322,7 @@ console.log(output);
 ╟────┼────┼────╢
 ║ 4A │ 4B │ 4C ║
 ╚════╧════╧════╝
+
 ```
 
 <a name="table-usage-padding-cell-content"></a>

diff --git a/test/README/usage/draw_horizontal_line.js b/test/README/usage/draw_horizontal_line.js
@@ -15,7 +15,7 @@ describe('README.md usage/', () => {
 
     const options = {
       /**
-       * @typedef {Function} drawJoin
+       * @typedef {Function} drawHorizontalLine
        * @param {number} index
        * @param {number} size
        * @returns {boolean}

diff --git a/test/configSamples.js b/test/configSamples.js
@@ -100,7 +100,7 @@ export default {
         paddingRight: 1
       }
 
-      // drawJoin: () => {
+      // drawHorizontalLine: () => {
       //     return false
       // }
     },

diff --git a/test/streamConfigSamples.js b/test/streamConfigSamples.js
@@ -99,7 +99,7 @@ export default {
         paddingRight: 1
       }
 
-      // drawJoin: () => {
+      // drawHorizontalLine: () => {
       //     return false
       // }
     },