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 cad3796 commit 3ad9f1f
Show file tree
Hide file tree
Showing 6 changed files with 29 additions and 29 deletions.
8 changes: 4 additions & 4 deletions docs/user_guide/nodes/list/search_list_element.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Search List Element

Description
-----------
This node search for a specific element and return some informaion about it.
This node searches for a specific element and returns some information about it.

.. image:: images/search_list_element_node.png
:width: 160pt
Expand All @@ -12,13 +12,13 @@ Inputs
------

- **List** - The input list.
- **Search** - A value to search for.This value being of the same data type as the input list.
- **Search** - A value to search for. This value being of the same data type as the input list.

Outputs
-------

- **First Index**
The index where the value first appeared in the list.So if the input list is
The index where the value first appeared in the list. So if the input list is
[1,2,3,2] and we are searching for 2 then the First Index will be 1 because
this is the index where the number 2 first appeared.

Expand All @@ -27,7 +27,7 @@ Outputs
above the output will be [1,3] because the number 2 appeared at both these indicies.

- **Occurrences**
The number of times the search value appeared on the list. So for the example
The number of times the search value appeared on the list. So for the example,
above the output will be 2 because number 2 appeared 2 times in the list.

Advanced Node Settings
Expand Down
2 changes: 1 addition & 1 deletion docs/user_guide/nodes/list/set_list_element.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Set List Element

Description
-----------
This node replace the value of the element at the input index by the input value.
This node replaces the value of the element at the input index by the input value.

.. image:: images/set_list_element_node.png
:width: 160pt
Expand Down
6 changes: 3 additions & 3 deletions docs/user_guide/nodes/list/set_struct_elements.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ Set Struct Elements

Description
-----------
This node creates struct elements and set its values. See demonstration for more
information about struct elements.A new key can be added using the plus button
This node creates struct elements and sets its values. See demonstration for more
information about struct elements. A new key can be added using the plus button
or by plugging its value into the transparent socket.

.. image:: images/set_struct_elements_node.png
Expand All @@ -17,7 +17,7 @@ Struct elements are not lists. They are what is known as dictionaries.
Dictionaries are lists but each element is known by a **Keys** instead of an indicies.
A key is a string that usually explain the value it is carrying.
Dictionaries unlike lists don't care about the elements order.
Dictionaries can carry multiple data type.
Dictionaries can carry multiple data types.

An example of a dictionaries : Name = Bob, Age = 19, Height = 1.70 .
Notice That every element has a key (Name,Age,Height) that describe its value
Expand Down
8 changes: 4 additions & 4 deletions docs/user_guide/nodes/list/shuffle_list.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,21 @@ Shuffle List

Description
-----------
This node redistribute the elements of the list in a random different order.
This node redistributes the elements of the list in a random different order.

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

Inputs
------

- **List** - An input list.
- **Seed** - A seed for the random generator,where different seeds output elements in different orders.
- **Seed** - A seed for the random generator, where different seeds output elements in different orders.

Outputs
-------

- **Shuffled List** - The list after the elements random redistribution.
- **Shuffled List** - The list after random redistribution of the elements.

Advanced Node Settings
-----------------------
Expand Down
16 changes: 8 additions & 8 deletions docs/user_guide/nodes/list/slice_list.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Slice List

Description
-----------
This node output only a portion of the input list.The type of the node change
This node outputs only a portion of the input list. The type of the node changes
automatically to whatever the data type you input.

.. image:: images/slice_list_node.png
Expand All @@ -13,24 +13,24 @@ Options
-------

- **Start,End and Step**
**Start** define the start index of the output list.So if the input list is
[1,2,3,4] and Start value is 2 then the new list will be [3,4] thats
**Start** defines the start index of the output list. So if the input list is
[1,2,3,4] and Start value is 2 then the new list will be [3,4] that's
because the node will reject the elements before that index and output a list
that start from that index.
that starts from that index.

**End** in the other hand define the ending index of the output list.
**End** on the other hand defines the ending index of the output list.
So assuming the start is 0 and end is 2 the output list will be [1,2,3]
thats because the node will reject the elements after that index and output a
list that end by that index.
list that ends by that index.

**Step** define the step size between every index. So if the step size is
**Step** define the step size between each index. So if the step size is
equal to 2 then the output list will be [1,3] notice that the index jumped
2 values to get from 1 to 3 and that what the step size define.

- **End Vs Length**
As explained above, the **End** define the ending index.
**Length** on the other hand defines the index starting from the start value.
In other words, the length is the length of the output list that start by the **Start** value.
In other words, the length is the length of the output list that starts with the **Start** value.

Inputs
------
Expand Down
18 changes: 9 additions & 9 deletions docs/user_guide/nodes/list/sort_list.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,29 +3,29 @@ Sort List

Description
-----------
This node sort a list of specific data type based on a specific property.
This node sorts a list of a specific data type based on a specific property.
The input list can be of any data type and there is 2 main options you can use for sorting :Custom expression and key list.
However, some data types have more than 2 ways of sorting like the objects and polygons lists.
However, some data types have more than 2 ways of sorting such as the objects and polygons lists.

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

Options
-------

- **Custom** - This option allow you to sort the list based on an input data attribute.So if the list data type is vectors you can use the expresion "e.x" which will sort the vectors based on their x component (from the smallest x to the largest x).Another example,If the list data type is stings you can use the expression "e[-1]" to sort the strings based on their last characters (starting from A to Z),Notice that -1 here is the index of the character in the string.
- **key List** - This opion allow you to sort list using a reference list.The reference list can be either floats or strings.Suppose I want to sort the list **[1,2,3,4]** to be **[3,1,2,4]**,The reference list for such order would be something like **[1,2,0,3]** this reference list get sorted from zero to infinity and the same movement that happened to sort this list will happen to the original list.So for instance the number 0 in the reference list is the smallest number and thus it should be the first element so we move it from the third location to the first location,That same movement will happen to the oiginal list, the element at the third location which is 3 will move to the first location (Noice that this what happened to get [1,2,3,4] to be [3,1,2,4]).The string reference list is exactl the same but it is sorted from A to Z and an altenative reference list in strings for [1,2,0,3] is [b,c,a,d].
- **Custom** - This option allow you to sort the list based on an input data attribute. So if the list data type is vectors, you can use the expresion "e.x" which will sort the vectors based on their x component (from the smallest x to the largest x). Another example, if the list data type is stings you can use the expression "e[-1]" to sort the strings based on their last characters (starting from A to Z),Notice that -1 here is the index of the character in the string.
- **key List** - This option allows you to sort list using a reference list. The reference list can be either floats or strings. Suppose I want to sort the list **[1,2,3,4]** to be **[3,1,2,4]**, the reference list for such order would be something like **[1,2,0,3]** this reference list gets sorted from zero to infinity and the same movement that happened to sort this list will happen to the original list. So for instance, the number 0 in the reference list is the smallest number and thus it should be the first element so we move it from the third location to the first location. That same movement will happen to the original list, the element at the third location(which is 3) will move to the first location (Notice that this what happened to get [1,2,3,4] to be [3,1,2,4]).The string reference list is exactly the same but it is sorted from A to Z and an altenative reference list in strings for [1,2,0,3] is [b,c,a,d].

- **Name** - This option only appear when the input list is an object data type.And it basically sort the objects based on their names from A to Z and it is just the same as using "e.name" in the custom option.
- **Point Distance** - This option only appear when the input list is an object data type.It sort the object based on their distance from an input point.If 2 objects are eqadistance from the point,they are sorted clockwise.The option also allow using the ID key initial transforms instead of the object's location.
- **Direction** - This option only appear when the input list is an object or polygon data type.It sorts the objects or polygons based on their distance to a plane centered at the point (0,0,0) and have a direction as the input direction.The option also allow using the ID key initial transforms instead of the object's location.
- **Name** - This option only appears when the input list is an object data type and it sorts the objects based on their names from A to Z. This is the same as using "e.name" in the custom option.
- **Point Distance** - This option only appears when the input list is an object data type. It sorts the objects based on their distance from an input point. If 2 objects are equidistant from the point, they are sorted clockwise. The option also allow using the ID key initial transforms instead of the object's location.
- **Direction** - This option only appears when the input list is an object or polygon data type. It sorts the objects or polygons based on their distance to a plane centered at the point (0,0,0) and have a direction as the input direction. The option also allows using the ID key initial transforms instead of the object's location.

Inputs
------

- **List** - An input list.
- **Key** - The reference list if key list option is choosen.
- *Reverse* - An opion to reverse the order of the output list.
- *Reverse* - An option to reverse the order of the output list.

Outputs
-------
Expand All @@ -35,7 +35,7 @@ Outputs
Advanced Node Settings
-----------------------

- **Element** - The variable used to define the elements of the input list in the custom expression option.By default it is "e".
- **Element** - The variable used to define the elements of the input list in the custom expression option. By default it is "e".

Examples of Usage
-----------------
Expand Down

0 comments on commit 3ad9f1f

Please sign in to comment.