Update some info in 'plotBarGraph' (#1993)

* edits for the ref page

* fix temp example text

* spell maximum
This commit is contained in:
Galen Nickel 2019-04-09 11:01:39 -07:00 committed by GitHub
parent 0868befa5c
commit 3424862910
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,30 +1,29 @@
# Plot Bar Graph # plot Bar Graph
Displays a bar graph of the numbers you say. Display a bar graph for a number value.
A bar graph is a kind of chart that shows numbers as lines with different lengths.
```sig ```sig
led.plotBarGraph(2, 20); led.plotBarGraph(2, 20);
``` ```
A bar graph is a kind of chart that shows numbers as lines with different lengths.
## Parameters ## Parameters
* ``value`` is a [number](/types/number) that means what you * **value**: a [number](/types/number) that is the value of what you
are measuring or trying to show. For example, if you are measuring are measuring or trying to show. For example, if you are measuring
the temperature of ice with the @boardname@, ``value`` might be `0` the temperature of ice with the @boardname@, ``value`` might be `0`
because the temperature might be 0 degrees centigrade. if the temperature is 0 degrees Celsius.
* ``high`` is a [number](/types/number) that means the highest * **high**: a [number](/types/number) that is the highest
possible number that the ``value`` parameter can be. This number is possible number (maximum) that the **value** parameter can be. The lines in the bar graph will reach their highest point when **value** reaches this number. If **high** is `0`, then the largest value recently plotted is used as the maximum.
also the tallest that the lines in the bar chart can be.
## Example: chart acceleration ## Example: chart acceleration
This program shows a bar graph of the [acceleration](/reference/input/acceleration) Show a bar graph of the [acceleration](/reference/input/acceleration)
in the `x` direction of the @boardname@. in the `x` direction of the @boardname@.
The @boardname@'s `x` direction is from left to right (or right to left). The @boardname@'s `x` direction is from left to right (or right to left).
The more you speed up moving the @boardname@ in this direction, The faster you move the @boardname@ in this direction,
the taller the lines in the bar graph will be, the taller the lines in the bar graph will be. The **high** paramter is `1023` which sets the highest possible value of acceleration to show.
until they are as tall as the parameter `high` says they can be.
```blocks ```blocks
basic.forever(() => { basic.forever(() => {