Skip to content

Commit

Permalink
Delay/Range node help tidy up
Browse files Browse the repository at this point in the history
  • Loading branch information
knolleary committed May 26, 2017
1 parent ac31957 commit b44e701
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
3 changes: 3 additions & 0 deletions nodes/core/core/89-delay.html
Expand Up @@ -106,6 +106,9 @@ <h3>Inputs</h3>
<dd>Sets the delay, in milliseconds, to be applied to the message. This
option only applies if the node is configured to allow the message to
provide the delay interval.</dd>
<dt class="optional">reset</dt>
<dd>If the received message has this property set to any value, all
outstanding messages held by the node are cleared without being sent.</dd>
</dl>
<h3>Details</h3>
<p>When configured to delay messages, the delay interval can be a fixed value
Expand Down
11 changes: 6 additions & 5 deletions nodes/core/logic/16-range.html
Expand Up @@ -33,24 +33,25 @@
</script>

<script type="text/x-red" data-help-name="range">
<p>A simple function node to remap numeric input values to another scale.</p>
<p>Maps a numeric value to a different range.</p>
<h3>Inputs</h3>
<dl class="message-properties">
<dt>payload <span class="property-type">number</span></dt>
<dd>the input payload <i>must</i> be a number. Anything else will try to be
<dd>The payload <i>must</i> be a number. Anything else will try to be
parsed into a number and rejected if that fails.</dd>
</dl>
<h3>Outputs</h3>
<dl class="message-properties">
<dt>payload <span class="property-type">number</span></dt>
<dd>the output payload will always be a numeric type..</dd>
<dd>The value mapped to the new range.</dd>
</dl>
<h3>Details</h3>
<p>Currently only does a linear scaling.</p>
<p>This node will linearly scale the received value. By default, the result
is not constrained to the range defined in the node.</p>
<p><i>Scale and limit to target range</i> means that the result will never be outside
the range specified within the result range.</p>
<p><i>Scale and wrap within the target range</i> means that the result will
be a "modulo-style" wrap-around within the result range.</p>
be wrapped within the result range.</p>
</script>

<script type="text/javascript">
Expand Down

0 comments on commit b44e701

Please sign in to comment.