Explain randomize better

Author: rugk

RandomTips.js

@@ -224,7 +224,7 @@ async function shouldBeShown(tipSpec, thisTipConfig, tipSpecOrig) {
     if (moduleConfig.triggeredOpen < tipSpec.requiredTriggers) {
         return false;
     }
-    // 1 : x -> if one number is not selected, do not display result
+    // only show result in x% of cases (uses float points < 1 for percentage)
     if (tipSpec.randomizeDisplay && !randomizePassed(tipSpec.randomizeDisplay)) {
         return false;
     }

examples/Tips.js

@@ -32,7 +32,9 @@
  * given number of times. See {@link RandomTips.setContext}.
  * @property {bool|integer} [randomizeDisplay=false] Randomizes the display with a
  * chance of 50% by default (when set to `true`). You can override that percentage
- * (as an integer, e.g. 0.2 instead of 20%).
+ * by specifying an integer < 1 (e.g. 0.2 for a 20% chance) as a propbability.
+ * The chance is the chance that the tip *is shown*, i.e. the tip is shown for
+ * <= p and not shown for < p if p is the propbability you pass.
  * Note that the tip message display in general is already randomized
  * with a chance of 20%, see {@link RandomTips.GLOBAL_RANDOMIZE}.
  * @property {string} text The text to actually show. It is passed to the