Skip to content

Commit

Permalink
grammar and clarity corrections
Browse files Browse the repository at this point in the history
  • Loading branch information
lordlatch committed Mar 14, 2017
1 parent 91e57cb commit c853141
Show file tree
Hide file tree
Showing 9 changed files with 19 additions and 19 deletions.
4 changes: 2 additions & 2 deletions docs/user_guide/nodes/number/integer_list.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Integer List

Description
-----------
This node is used to create an arbitrary list of integers. A new integer can be added with the *New Input* button. A new integer can also be added by plugging it into the transperant socket.
This node is used to create an arbitrary list of integers. A new integer can be added with the *New Input* button. A new integer can also be added by plugging it into the transparent socket.

.. image:: images/integer_list_node.png
:width: 160pt
Expand All @@ -28,7 +28,7 @@ Advanced Node Settings

Caution
-------
A warning pop up when you use the *Remove All* button in the node, while if you used the the *Remove All* button in the *Advanced Node Settings* the inputs will be removed without a warning.
A warning will pop up when you use the *Remove All* button in the node, while if you used the the *Remove All* button in the *Advanced Node Settings* the inputs will be removed without a warning.

Examples of Usage
-----------------
Expand Down
4 changes: 2 additions & 2 deletions docs/user_guide/nodes/number/integer_range.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@ Integer Range

Description
-----------
This node is use to generate an list of integers between 2 integers. It support a custom step size which define the difference between integers in the list.
This node is used to generate an list of integers between 2 integers. It supports a custom step size which defines the difference between integers in the list.

.. image:: images/integer_range_node.png
:width: 160pt

Inputs
------

- **Amount** - The length of the generated list, It can also be the end integer from another point of view.
- **Amount** - The length of the generated list- It can also be the end integer from another point of view.
- **Start** - It is the integer where the list should starts.
- **Step** - It is the difference between each integer. So if the *Step* is equal to 3, every integer will be bigger than the previouse by 3.

Expand Down
8 changes: 4 additions & 4 deletions docs/user_guide/nodes/number/map_range.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Map Range

Description
-----------
This node remap a value from a defined interval to a new interval.
This node remaps a value from a defined interval to a new interval.
Every value has a relative position in a specific interval, This node find a new value that match the relative position but in a new defined interval.

.. image:: images/map_range_node.png
Expand Down Expand Up @@ -35,13 +35,13 @@ Note
If the input value is outside the original interval, it will be remapped relative to the start and the end of the new interval.
That's why the node has an option to **Clamp Input**.

The node also support non linear interpolation, It means the value will not be remapped uniformly across the whole interval, **Custom Interpolations** will enable you to remape the input value based on its relative position in the original interval.
To be able to understand the **Custom Interpolation**, We reccomend you use the interval [0,1] for both the original and the new interval, then try using different interpolations and see how the output change as you change the value.
The node also supports non linear interpolation, It means the value will not be remapped uniformly across the whole interval, **Custom Interpolations** will enable you to remap the input value based on its relative position in the original interval.
To be able to understand the **Custom Interpolation**, We reccomend you use the interval [0,1] for both the original and the new interval, then try using different interpolations and see how the output changes as you change the value.

Warning
-------

**Custom Interpolation** will not work unless **Clamp Input** is enabled, because interpolation operate on normalized scales.
**Custom Interpolation** will not work unless **Clamp Input** is enabled, because interpolation operates on normalized scales.

Examples of Usage
-----------------
Expand Down
6 changes: 3 additions & 3 deletions docs/user_guide/nodes/number/math.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@ Math

Description
-----------
This node carry 26 math operation:
This node performs 26 math operations:

- **Add** - Adds input A to input B.
- **Subtract** - Subtract input B from input A.
- **Multiply** - Multiply input A by input B.
- **Multiply** - Multiplies input A by input B.
- **Divide** - Divides input A by input B.
- **Sine** - Calculate the sin of input A.
- **Sine** - Calculate the sine of input A.
- **Cosine** - Claculate the cosine of input A.
- **Tangent** - Calculate the tangent of input A.
- **Arcsine** - Calaculate the arcsine of input A.
Expand Down
4 changes: 2 additions & 2 deletions docs/user_guide/nodes/number/mix_floats.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Mix floats

Description
-----------
This node mix between 2 floats by a defined factor.
This node mixes between 2 floats by a defined factor.

.. image:: images/mix_floats_node.png
:width: 160pt
Expand All @@ -27,7 +27,7 @@ Advanced Node Settings
Note
----

By how the *Mix floats* works, A factor that is larger than 1 won't be clamped but rather multiplied to the second float, That's why the node has an option to *Clamp Factor*. So if *Clamp factor* is enables, Any factor that is larger than 1 will return the second float.
By how the *Mix floats* works, A factor that is larger than 1 won't be clamped but rather multiplied to the second float- that's why the node has an option to *Clamp Factor*. So if *Clamp factor* is enabled, any factor that is larger than 1 will return the second float.

Examples of Usage
-----------------
Expand Down
4 changes: 2 additions & 2 deletions docs/user_guide/nodes/number/number_list_math.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ Number List Math

Description
-----------
This node carry 5 math operations that deals with lists:
This node performs 5 math operations on lists:

- **Add** - Adds all the elements of the list.
- **Multiply** - Multiplies all the elements on the list.
- **Min** - Rerturns the smallest number in the list.
- **Max** - Returns the biggest number in the list.
- **Max** - Returns the largest number in the list.
- **Average** - Returns the average of all the elements of the list.

.. image:: images/number_list_math_node.png
Expand Down
4 changes: 2 additions & 2 deletions docs/user_guide/nodes/number/number_wiggle.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Number Wiggle

Description
-----------
This node is a 1D pelin noise generator, You can think of it as random numbers that are smoothly connected to each other.
This node is a 1D perlin noise generator, You can think of it as random numbers that are smoothly connected to each other.

It is a function of variable **Evolution**, Which means every value of the variable **Evolution** has a corresponding value calculated based on the node options and this value is the output of the node.

Expand All @@ -17,7 +17,7 @@ Inputs
- **Evolution** - A float that is the variable of the function wiggle.
- **Speed** - It is the frequency of the noise or the rate of change of the values.
- **Amplitude** - It is the range of the output values in both positive and negative direction, Means if the *Amplitude* is equal to 1, the value will range between -1 and 1.
- **Octaves** - It is the number of levels of deatils.
- **Octaves** - It is the number of levels of details.
- **Persistance** - It is the strength of the details added from *Octaves*

.. image:: gifs/number_wiggle_node_speed.gif
Expand Down
2 changes: 1 addition & 1 deletion docs/user_guide/nodes/number/parse_number.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Advanced Node Settings
Caution
-------

The input text should only include numbers, Otherwise the node will resturn a parsing error.
The input text should only include numbers, Otherwise the node will return a parsing error.

Examples of Usage
-----------------
Expand Down
2 changes: 1 addition & 1 deletion docs/user_guide/nodes/number/random_number.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Random Number

Description
-----------
This node generate a random float between a minimum and a maximum value.
This node generates a random float between a minimum and a maximum value.

.. image:: images/random_number_node.png
:width: 160pt
Expand Down

0 comments on commit c853141

Please sign in to comment.