Dynamo core annotations 1-10 (#11103)

martinstacey · web-flow · commit 3e50feb7bf8d · 2020-10-06T14:52:58.000-04:00
* String from Object Annotations Update

**NODE:  String from Object**
-CHANGES: Rename str to string, obj to object,  Output description: String representation of the object.
-NOT APPLICABLE: Name has spaces, does not have DS Syntax
-FUTURE EDITS: Retain Existing -&gt; Pending explanation from Sol

* String from Array Annotations Update

**NODE:  String from Array**
-CHANGES: Rename str to string, arr to array
-NOT APPLICABLE: Name has spaces, does not have DS Syntax
-FUTURE EDITS:  Retain Existing -&gt; Pending explanation from Sol

* Function.Apply Annotations Update

**NODE:  Function Apply**
-CHANGES: Rename func to function, arg1 to argument1 func(args) to result,
Description:  Returns the result of a function with supplied arguments. Ex: arguments of a point and vector are applied to a translate function returning a translated point.
-NOT APPLICABLE: Name has spaces, does not have DS Syntax, items is not zero indexed, doesnt pass object-type

* Function Compose Annotation Update

**NODE:  Function Compose**
-CHANGES: Rename func0 to function0, fun to function
Description:  Returns a single function from multiple functions. Ex: the modulus and divide functions are composed into a single function to apply to a list.
-NOT APPLICABLE: Name has spaces, does not have DS Syntax

* List.LaceShortest List.LaceLongest List.Combine Annotation Update

**NODES: List.LaceShortest List.LaceLongest List.Combine**
-CHANGES: Rename comb to combinator, list1 to list0, combined to list
Input Description: function to use as combinator

* List.GroupByFunction Annotation Update

**NODE: List.GroupByFunction**
-CHANGES: Rename func to groupFunction, var[]..[] to list
Description:   Returns a new list grouped by a function.
Description Inputs:
groupFunction = function for grouping list
groupedList = Grouped list

* Using appropiate tooltip for Object to String description

Tooltip FormulaPortDataResultToolTip was being used for String from Object output description

* Function Apply index to 0

All indexes should start at 0

* List.GroupByFunction search update

Eliminate groupByfunction search option as it is name of node and is not needed for search.

* List.GroupByFunction Update output description

List.GroupByFunction output description updated to reflect type:
type: var[]..[] (list of arbitrary rank/levels)

* List.LaceShortest, List.LaceLongest, List.Combine, List.CartesionProduct update input name

combinator -&gt; combineFunction

* List.GroupByFunction update output description

&gt;type: var[]..[] (list of arbitrary rank/levels)
to
List of arbitrary rank/levels (type: var[]..[])
diff --git a/src/DynamoCore/BuiltInAndOperators/BuiltIn.xml b/src/DynamoCore/BuiltInAndOperators/BuiltIn.xml
@@ -138,7 +138,8 @@
     <member name="List.GroupByFunction">
       <summary>Use a function to determine how list items should be grouped.</summary>
       <param name="list">list of values</param>
-      <param name="function"></param>
+      <param name="groupFunction">Function to group list</param>
+      <returns name="groupedList">List of arbitrary rank/levels (type: var[]..[])</returns>
       <search>group,function</search>
     </member>
     <member name="List.TrueForAll">
diff --git a/src/Engine/ProtoCore/ExtendedLibraries/BuiltIn.ds b/src/Engine/ProtoCore/ExtendedLibraries/BuiltIn.ds
@@ -12,9 +12,9 @@ class List extends DSCore.List
         return __Equals(objectA, objectB);
 	}
 
-	public static def GroupByFunction(list: var[]..[], func: Function)
+	public static def GroupByFunction(list: var[]..[], groupFunction: Function)
 	{
-		return __GroupByFunction(list, func);
+		return __GroupByFunction(list, groupFunction);
 	}
 
 	public static def SortByFunction(list: var[]..[], sortFunction: Function)
diff --git a/src/Libraries/CoreNodeModels/HigherOrder/Apply.cs b/src/Libraries/CoreNodeModels/HigherOrder/Apply.cs
@@ -22,26 +22,26 @@ private ApplyFunction(IEnumerable<PortModel> inPorts, IEnumerable<PortModel> out
 
         public ApplyFunction() : base()
         {
-            InPorts.Add(new PortModel(PortType.Input, this, new PortData("func", Resources.ApplyPortDataFuncToolTip)));
-            OutPorts.Add(new PortModel(PortType.Output, this, new PortData("func(args)", Resources.ApplyPortDataFuncArgToolTip)));
+            InPorts.Add(new PortModel(PortType.Input, this, new PortData("function", Resources.ApplyPortDataFuncToolTip)));
+            OutPorts.Add(new PortModel(PortType.Output, this, new PortData("result", Resources.ApplyPortDataFuncArgToolTip)));
             AddInput();
             RegisterAllPorts();
         }
 
         protected override string GetInputName(int index)
         {
             if (index == 0)
-                return "func";
+                return "function";
 
-            return "arg" + index;
+            return "argument" + (index-1);
         }
 
         protected override string GetInputTooltip(int index)
         {
             if (index == 0)
                 return "Function to apply.";
 
-            return "Argument #" + index;
+            return "Argument #" + (index-1);
         }
 
         protected override void RemoveInput()
@@ -85,15 +85,15 @@ private ComposeFunctions(IEnumerable<PortModel> inPorts, IEnumerable<PortModel>
 
         public ComposeFunctions()
         {
-            InPorts.Add(new PortModel(PortType.Input, this, new PortData("func0", Resources.ComposePortDataFunc0ToolTip)));
-            InPorts.Add(new PortModel(PortType.Input, this, new PortData("func1", Resources.ComposePortDataFunc1ToolTip)));
-            OutPorts.Add(new PortModel(PortType.Output, this, new PortData("func", Resources.ComposePortDataResultToolTip)));
+            InPorts.Add(new PortModel(PortType.Input, this, new PortData("function0", Resources.ComposePortDataFunc0ToolTip)));
+            InPorts.Add(new PortModel(PortType.Input, this, new PortData("function1", Resources.ComposePortDataFunc1ToolTip)));
+            OutPorts.Add(new PortModel(PortType.Output, this, new PortData("function", Resources.ComposePortDataResultToolTip)));
             RegisterAllPorts();
         }
 
         protected override string GetInputName(int index)
         {
-            return "func" + index;
+            return "function" + index;
         }
 
         protected override string GetInputTooltip(int index)
diff --git a/src/Libraries/CoreNodeModels/HigherOrder/MapCombineLacing.cs b/src/Libraries/CoreNodeModels/HigherOrder/MapCombineLacing.cs
@@ -57,11 +57,11 @@ protected CombinatorNode(IEnumerable<PortModel> inPorts, IEnumerable<PortModel>
 
         protected CombinatorNode() : this(3)
         {
-            InPorts.Add(new PortModel(PortType.Input, this, new PortData("comb", Resources.CombinatorPortDataCombToolTip)));
+            InPorts.Add(new PortModel(PortType.Input, this, new PortData("combineFunction", Resources.CombinatorPortDataCombToolTip)));
+            InPorts.Add(new PortModel(PortType.Input, this, new PortData("list0", Resources.PortDataListToolTip + " #0")));
             InPorts.Add(new PortModel(PortType.Input, this, new PortData("list1", Resources.PortDataListToolTip + " #1")));
-            InPorts.Add(new PortModel(PortType.Input, this, new PortData("list2", Resources.PortDataListToolTip + " #2")));
 
-            OutPorts.Add(new PortModel(PortType.Output, this, new PortData("combined", Resources.CombinatorPortDataResultToolTip)));
+            OutPorts.Add(new PortModel(PortType.Output, this, new PortData("list", Resources.CombinatorPortDataResultToolTip)));
 
             RegisterAllPorts();
         }
@@ -73,12 +73,12 @@ protected CombinatorNode(int minPorts)
 
         protected override string GetInputName(int index)
         {
-            return "list" + index;
+            return "list" + (index-1);
         }
 
         protected override string GetInputTooltip(int index)
         {
-            return Resources.PortDataListToolTip + " #" + index;
+            return Resources.PortDataListToolTip + " #" + (index-1);
         }
 
         protected override void RemoveInput()
diff --git a/src/Libraries/CoreNodeModels/Properties/Resources.Designer.cs b/src/Libraries/CoreNodeModels/Properties/Resources.Designer.cs
diff --git a/src/Libraries/CoreNodeModels/Properties/Resources.en-US.resx b/src/Libraries/CoreNodeModels/Properties/Resources.en-US.resx
@@ -152,7 +152,7 @@
     <value>A list of values between 0.0 and 1.0. These values are used to look up the color within the range.</value>
   </data>
   <data name="CombinatorPortDataCombToolTip" xml:space="preserve">
-    <value>Combinator</value>
+    <value>Function to use as combinator</value>
   </data>
   <data name="CombinatorPortDataResultToolTip" xml:space="preserve">
     <value>Combined lists</value>
@@ -265,11 +265,11 @@
     <comment>Search tags. When do translation, appending localized tags to the existing tags and use ';' to seperate them</comment>
   </data>
   <data name="FunctionApplyDescription" xml:space="preserve">
-    <value>Applies a function to arguments.</value>
+    <value>Returns the result of a function with supplied arguments. Ex: arguments of a point and vector are applied to a translate function returning a translated point.</value>
     <comment>Description for Function.Apply</comment>
   </data>
   <data name="FunctionComposeDescription" xml:space="preserve">
-    <value>Compose multiple functions.</value>
+    <value>Returns a single function from multiple functions. Ex: the modulus and divide functions are composed into a single function to apply to a list.</value>
     <comment>Description for Function.Compose</comment>
   </data>
   <data name="IfDescription" xml:space="preserve">
diff --git a/src/Libraries/CoreNodeModels/Properties/Resources.resx b/src/Libraries/CoreNodeModels/Properties/Resources.resx
@@ -152,7 +152,7 @@
     <value>A list of values between 0.0 and 1.0. These values are used to look up the color within the range.</value>
   </data>
   <data name="CombinatorPortDataCombToolTip" xml:space="preserve">
-    <value>Combinator</value>
+    <value>Function to use as combinator</value>
   </data>
   <data name="CombinatorPortDataResultToolTip" xml:space="preserve">
     <value>Combined lists</value>
@@ -265,11 +265,11 @@
     <comment>Search tags. When do translation, appending localized tags to the existing tags and use ';' to seperate them</comment>
   </data>
   <data name="FunctionApplyDescription" xml:space="preserve">
-    <value>Applies a function to arguments.</value>
+    <value>Returns the result of a function with supplied arguments. Ex: arguments of a point and vector are applied to a translate function returning a translated point.</value>
     <comment>Description for Function.Apply</comment>
   </data>
   <data name="FunctionComposeDescription" xml:space="preserve">
-    <value>Compose multiple functions.</value>
+    <value>Returns a single function from multiple functions. Ex: the modulus and divide functions are composed into a single function to apply to a list.</value>
     <comment>Description for Function.Compose</comment>
   </data>
   <data name="IfDescription" xml:space="preserve">
diff --git a/src/Libraries/CoreNodeModels/String.cs b/src/Libraries/CoreNodeModels/String.cs
@@ -78,8 +78,8 @@ private FromObject(IEnumerable<PortModel> inPorts, IEnumerable<PortModel> outPor
         public FromObject() : base("__ToStringFromObject")
         {
             ArgumentLacing = LacingStrategy.Disabled;
-            InPorts.Add(new PortModel(PortType.Input, this, new PortData("obj", Resources.FromObjectPortDataObjToolTip)));
-            OutPorts.Add(new PortModel(PortType.Output, this, new PortData("str", Resources.FormulaPortDataResultToolTip)));
+            InPorts.Add(new PortModel(PortType.Input, this, new PortData("object", Resources.FromObjectPortDataObjToolTip)));
+            OutPorts.Add(new PortModel(PortType.Output, this, new PortData("string", Resources.FromObjectPortDataResultToolTip)));
             RegisterAllPorts();
         }
     }
@@ -103,8 +103,8 @@ private FromArray(IEnumerable<PortModel> inPorts, IEnumerable<PortModel> outPort
         public FromArray() : base("__ToStringFromArray")
         {
             ArgumentLacing = LacingStrategy.Disabled;
-            InPorts.Add(new PortModel(PortType.Input, this, new PortData("arr", Resources.FromArrayPortDataArrayToolTip)));
-            OutPorts.Add(new PortModel(PortType.Output, this, new PortData("str", Resources.FromArrayPortDataResultToolTip)));
+            InPorts.Add(new PortModel(PortType.Input, this, new PortData("array", Resources.FromArrayPortDataArrayToolTip)));
+            OutPorts.Add(new PortModel(PortType.Output, this, new PortData("string", Resources.FromArrayPortDataResultToolTip)));
             RegisterAllPorts();
         }
     }

Original file line number	Diff line number	Diff line change
`@@ -12,9 +12,9 @@ class List extends DSCore.List`
`12`	`12`	`return __Equals(objectA, objectB);`
`13`	`13`	`}`
`14`	`14`
`15`		`- public static def GroupByFunction(list: var[]..[], func: Function)`
	`15`	`+ public static def GroupByFunction(list: var[]..[], groupFunction: Function)`
`16`	`16`	`{`
`17`		`- return __GroupByFunction(list, func);`
	`17`	`+ return __GroupByFunction(list, groupFunction);`
`18`	`18`	`}`
`19`	`19`
`20`	`20`	`public static def SortByFunction(list: var[]..[], sortFunction: Function)`
Original file line number	Diff line number	Diff line change
`@@ -22,26 +22,26 @@ private ApplyFunction(IEnumerable<PortModel> inPorts, IEnumerable<PortModel> out`
`22`	`22`
`23`	`23`	`public ApplyFunction() : base()`
`24`	`24`	`{`
`25`		`- InPorts.Add(new PortModel(PortType.Input, this, new PortData("func", Resources.ApplyPortDataFuncToolTip)));`
`26`		`- OutPorts.Add(new PortModel(PortType.Output, this, new PortData("func(args)", Resources.ApplyPortDataFuncArgToolTip)));`
	`25`	`+ InPorts.Add(new PortModel(PortType.Input, this, new PortData("function", Resources.ApplyPortDataFuncToolTip)));`
	`26`	`+ OutPorts.Add(new PortModel(PortType.Output, this, new PortData("result", Resources.ApplyPortDataFuncArgToolTip)));`
`27`	`27`	`AddInput();`
`28`	`28`	`RegisterAllPorts();`
`29`	`29`	`}`
`30`	`30`
`31`	`31`	`protected override string GetInputName(int index)`
`32`	`32`	`{`
`33`	`33`	`if (index == 0)`
`34`		`- return "func";`
	`34`	`+ return "function";`
`35`	`35`
`36`		`- return "arg" + index;`
	`36`	`+ return "argument" + (index-1);`
`37`	`37`	`}`
`38`	`38`
`39`	`39`	`protected override string GetInputTooltip(int index)`
`40`	`40`	`{`
`41`	`41`	`if (index == 0)`
`42`	`42`	`return "Function to apply.";`
`43`	`43`
`44`		`- return "Argument #" + index;`
	`44`	`+ return "Argument #" + (index-1);`
`45`	`45`	`}`
`46`	`46`
`47`	`47`	`protected override void RemoveInput()`
`@@ -85,15 +85,15 @@ private ComposeFunctions(IEnumerable<PortModel> inPorts, IEnumerable<PortModel>`
`85`	`85`
`86`	`86`	`public ComposeFunctions()`
`87`	`87`	`{`
`88`		`- InPorts.Add(new PortModel(PortType.Input, this, new PortData("func0", Resources.ComposePortDataFunc0ToolTip)));`
`89`		`- InPorts.Add(new PortModel(PortType.Input, this, new PortData("func1", Resources.ComposePortDataFunc1ToolTip)));`
`90`		`- OutPorts.Add(new PortModel(PortType.Output, this, new PortData("func", Resources.ComposePortDataResultToolTip)));`
	`88`	`+ InPorts.Add(new PortModel(PortType.Input, this, new PortData("function0", Resources.ComposePortDataFunc0ToolTip)));`
	`89`	`+ InPorts.Add(new PortModel(PortType.Input, this, new PortData("function1", Resources.ComposePortDataFunc1ToolTip)));`
	`90`	`+ OutPorts.Add(new PortModel(PortType.Output, this, new PortData("function", Resources.ComposePortDataResultToolTip)));`
`91`	`91`	`RegisterAllPorts();`
`92`	`92`	`}`
`93`	`93`
`94`	`94`	`protected override string GetInputName(int index)`
`95`	`95`	`{`
`96`		`- return "func" + index;`
	`96`	`+ return "function" + index;`
`97`	`97`	`}`
`98`	`98`
`99`	`99`	`protected override string GetInputTooltip(int index)`
Original file line number	Diff line number	Diff line change
`@@ -57,11 +57,11 @@ protected CombinatorNode(IEnumerable<PortModel> inPorts, IEnumerable<PortModel>`
`57`	`57`
`58`	`58`	`protected CombinatorNode() : this(3)`
`59`	`59`	`{`
`60`		`- InPorts.Add(new PortModel(PortType.Input, this, new PortData("comb", Resources.CombinatorPortDataCombToolTip)));`
	`60`	`+ InPorts.Add(new PortModel(PortType.Input, this, new PortData("combineFunction", Resources.CombinatorPortDataCombToolTip)));`
	`61`	`+ InPorts.Add(new PortModel(PortType.Input, this, new PortData("list0", Resources.PortDataListToolTip + " #0")));`
`61`	`62`	`InPorts.Add(new PortModel(PortType.Input, this, new PortData("list1", Resources.PortDataListToolTip + " #1")));`
`62`		`- InPorts.Add(new PortModel(PortType.Input, this, new PortData("list2", Resources.PortDataListToolTip + " #2")));`
`63`	`63`
`64`		`- OutPorts.Add(new PortModel(PortType.Output, this, new PortData("combined", Resources.CombinatorPortDataResultToolTip)));`
	`64`	`+ OutPorts.Add(new PortModel(PortType.Output, this, new PortData("list", Resources.CombinatorPortDataResultToolTip)));`
`65`	`65`
`66`	`66`	`RegisterAllPorts();`
`67`	`67`	`}`
`@@ -73,12 +73,12 @@ protected CombinatorNode(int minPorts)`
`73`	`73`
`74`	`74`	`protected override string GetInputName(int index)`
`75`	`75`	`{`
`76`		`- return "list" + index;`
	`76`	`+ return "list" + (index-1);`
`77`	`77`	`}`
`78`	`78`
`79`	`79`	`protected override string GetInputTooltip(int index)`
`80`	`80`	`{`
`81`		`- return Resources.PortDataListToolTip + " #" + index;`
	`81`	`+ return Resources.PortDataListToolTip + " #" + (index-1);`
`82`	`82`	`}`
`83`	`83`
`84`	`84`	`protected override void RemoveInput()`
Original file line number	Diff line number	Diff line change
`@@ -78,8 +78,8 @@ private FromObject(IEnumerable<PortModel> inPorts, IEnumerable<PortModel> outPor`
`78`	`78`	`public FromObject() : base("__ToStringFromObject")`
`79`	`79`	`{`
`80`	`80`	`ArgumentLacing = LacingStrategy.Disabled;`
`81`		`- InPorts.Add(new PortModel(PortType.Input, this, new PortData("obj", Resources.FromObjectPortDataObjToolTip)));`
`82`		`- OutPorts.Add(new PortModel(PortType.Output, this, new PortData("str", Resources.FormulaPortDataResultToolTip)));`
	`81`	`+ InPorts.Add(new PortModel(PortType.Input, this, new PortData("object", Resources.FromObjectPortDataObjToolTip)));`
	`82`	`+ OutPorts.Add(new PortModel(PortType.Output, this, new PortData("string", Resources.FromObjectPortDataResultToolTip)));`
`83`	`83`	`RegisterAllPorts();`
`84`	`84`	`}`
`85`	`85`	`}`
`@@ -103,8 +103,8 @@ private FromArray(IEnumerable<PortModel> inPorts, IEnumerable<PortModel> outPort`
`103`	`103`	`public FromArray() : base("__ToStringFromArray")`
`104`	`104`	`{`
`105`	`105`	`ArgumentLacing = LacingStrategy.Disabled;`
`106`		`- InPorts.Add(new PortModel(PortType.Input, this, new PortData("arr", Resources.FromArrayPortDataArrayToolTip)));`
`107`		`- OutPorts.Add(new PortModel(PortType.Output, this, new PortData("str", Resources.FromArrayPortDataResultToolTip)));`
	`106`	`+ InPorts.Add(new PortModel(PortType.Input, this, new PortData("array", Resources.FromArrayPortDataArrayToolTip)));`
	`107`	`+ OutPorts.Add(new PortModel(PortType.Output, this, new PortData("string", Resources.FromArrayPortDataResultToolTip)));`
`108`	`108`	`RegisterAllPorts();`
`109`	`109`	`}`
`110`	`110`	`}`