docstrings

src/OpenSheetMusicDisplay/OSMDOptions.ts

@@ -18,7 +18,7 @@ export interface IOSMDOptions {
     autoBeamOptions?: AutoBeamOptions;
     /** Automatically resize score with canvas size. Default is true. */
     autoResize?: boolean;
-    /** Render Backend, will be SVG if given undefined, SVG or svg, otherwise Canvas. */
+    /** Render Backend, will be SVG if given undefined, "SVG" or "svg", otherwise Canvas. */
     backend?: string;
     /** Defines the mode that is used for coloring: XML (0), Boomwhacker(1), CustomColorSet (2). Default XML.
      *  If coloringMode.CustomColorSet (2) is chosen, a coloringSetCustom parameter must be added.
@@ -118,7 +118,7 @@ export interface IOSMDOptions {
      *  Example: "#FFFFFF" = white. "#12345600" = transparent.
      *  This can be useful when you want to export an image with e.g. white background color instead of transparent,
      *  from a CanvasBackend.
-     *  Note: Using a background color will prevent the cursor from being visible.
+     *  Note: Using a background color will prevent the cursor from being visible for now (will be fixed at some point).
      */
     pageBackgroundColor?: string;
     /** This makes OSMD render on one single horizontal (staff-)line. */

test/Util/generateImages_browserless.js

@@ -31,7 +31,7 @@ async function init () {
             'node test/Util/generateImages_browserless.js osmdBuildDir sampleDirectory imageDirectory [width|0] [height|0] [filterRegex|all|allSmall] [--debug] [debugSleepTime]')
         console.log('  (use "all" to skip filterRegex parameter. "allSmall" skips two huge OSMD samples that take forever to render)')
         console.log('example: node test/Util/generateImages_browserless.js ../../build ./test/data/ ./export 210 297 allSmall --debug 5000')
-        console.log('Error: need sampleDir and imageDir. Exiting.')
+        console.log('Error: need osmdBuildDir, sampleDir and imageDir. Exiting.')
         process.exit(1)
     }