diff --git a/doc.json b/doc.json index 6306c8d9..692ba029 100644 --- a/doc.json +++ b/doc.json @@ -1,11 +1,11 @@ { "docs": [ { - "comment": "/**\n * Intended for a debugging, drawLine renders the pattern as a string, where each character represents the same time span.\n * Should only be used with single characters as values, otherwise the character slots will be messed up.\n * Character legend: \n * \n * - \"|\" cycle separator\n * - \"-\" hold previous value\n * - \".\" silence\n *\n * @param {Pattern} pat pattern to use\n * @param {number} chars max number of characters (approximately)\n * @returns string\n * @example\n * const line = drawLine(\"0 [1 2 3]\", 10); // |0--123|0--123\n * console.log(line);\n */", + "comment": "/**\n * Intended for a debugging, drawLine renders the pattern as a string, where each character represents the same time span.\n * Should only be used with single characters as values, otherwise the character slots will be messed up.\n * Character legend:\n *\n * - \"|\" cycle separator\n * - \"-\" hold previous value\n * - \".\" silence\n *\n * @param {Pattern} pattern the pattern to use\n * @param {number} chars max number of characters (approximately)\n * @returns string\n * @example\n * const line = drawLine(\"0 [1 2 3]\", 10); // |0--123|0--123\n * console.log(line);\n */", "meta": { "range": [ - 1408, - 2778 + 1414, + 2784 ], "filename": "drawLine.mjs", "lineno": 25, @@ -44,8 +44,8 @@ "Pattern" ] }, - "description": "
pattern to use
", - "name": "pat" + "description": "the pattern to use
", + "name": "pattern" }, { "type": { @@ -54,8 +54,7 @@ ] }, "description": "max number of characters (approximately)
", - "name": "chars", - "defaultvalue": 60 + "name": "chars" } ], "returns": [ diff --git a/packages/core/drawLine.mjs b/packages/core/drawLine.mjs index 68c3be86..da424236 100644 --- a/packages/core/drawLine.mjs +++ b/packages/core/drawLine.mjs @@ -15,7 +15,7 @@ import Fraction, { gcd } from './fraction.mjs'; * - "-" hold previous value * - "." silence * - * @param {Pattern} pat pattern to use + * @param {Pattern} pattern the pattern to use * @param {number} chars max number of characters (approximately) * @returns string * @example diff --git a/tutorial/ApiDoc.jsx b/tutorial/ApiDoc.jsx index 1408f9ec..2d642ff1 100644 --- a/tutorial/ApiDoc.jsx +++ b/tutorial/ApiDoc.jsx @@ -3,7 +3,7 @@ import { docs } from '../doc.json'; import { MiniRepl } from './MiniRepl'; function ApiDoc() { - console.log('docJson', docs); + // console.log('docJson', docs); return (