Dynamo core annotations 1-10 #11103

martinstacey · 2020-09-10T09:08:13Z

Purpose

The following PR addresses nodes' names and descriptions to make them more descriptive for beginners. This is the first PR of the series. More PRs will come subsequently.

1) NODE: String from Object
-CHANGES: Rename str to string, obj to object, Output description: String representation of the object.

2) NODE: String from Array
-CHANGES: Rename str to string, arr to array

3) NODE: Output
-Autodesk will take care of making this node not appear on library

4) NODE: Function Apply
-CHANGES: Rename func to function, arg1 to argument0 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.

5) NODE: CoordinateSystem.ByMatrix
-Autodesk will deprecate this node.

6) 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.

7) 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.

8) NODE: List.LaceShortest
-CHANGES: Rename comb to combinator, list1 to list0, combined to list
Input Description: function to use as combinator

9) NODE: List.LaceLongest
-CHANGES: Rename comb to combinator, list1 to list0, combined to list
Input Description: function to use as combinator

10) NODE: List.Combine
-CHANGES: Rename comb to combinator, list1 to list0, combined to list
Input Description: function to use as combinator

11) NODE: List.CartesianProduct (changed automatically by addressing nodes 8-10)
-CHANGES: Rename comb to combinator, list1 to list0, combined to list
Input Description: function to use as combinator

Declarations

Check these if you believe they are true

The codebase is in a better state after this PR
Is documented according to the standards
The level of testing this PR includes is appropriate
User facing strings, if any, are extracted into *.resx files
All tests pass using the self-service CI.
Snapshot of UI changes, if any.
Changes to the API follow Semantic Versioning and are documented in the API Changes document.
This PR modifies some build requirements and the readme is updated

Reviewers

@SHKnudsen
@Amoursol
@QilongTang

FYIs

-Autodesk should take care of making node Output not appear on library search and deprecate CoordinateSystem.ByMatrix
-Sol confirmed not renaming nodes that do not have DS syntax and starting all lists with 0 indexes.
-String from Object output was fixed to use appropriate tooltip

**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 -> Pending explanation from Sol

**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 -> Pending explanation from Sol

**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

**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

**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

**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

Tooltip FormulaPortDataResultToolTip was being used for String from Object output description

All indexes should start at 0

src/DynamoCore/BuiltInAndOperators/BuiltIn.xml

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

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

Amoursol · 2020-09-21T17:21:05Z

JIRA task for LibG improvements added here: https://jira.autodesk.com/browse/DYN-3145

Amoursol · 2020-09-30T15:48:57Z

@martinstacey please update the following:
combinator --> combineFunction for all 4x nodes using it as an input port.

Some review comments are yet to be addressed.

aparajit-pratap · 2020-10-01T16:30:45Z

@martinstacey aside from @Amoursol's comments about changing combinator -> combineFunction, this is good to go. Will wait for you to make those remaining changes.

…uct update input name combinator -> combineFunction

martinstacey · 2020-10-05T08:44:38Z

@martinstacey please update the following:
combinator --> combineFunction for all 4x nodes using it as an input port.

addressed in d5ab208

>type: var[]..[] (list of arbitrary rank/levels) to List of arbitrary rank/levels (type: var[]..[])

martinstacey added 8 commits September 1, 2020 21:29

String from Array Annotations Update

ce700a8

**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 -> Pending explanation from Sol

List.LaceShortest List.LaceLongest List.Combine Annotation Update

2b18fc7

**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

b511e99

**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

f41b4c7

Tooltip FormulaPortDataResultToolTip was being used for String from Object output description

Function Apply index to 0

d7523b5

All indexes should start at 0

martinstacey changed the title ~~Dynamo core annotations~~ Dynamo core annotations 1-10 Sep 10, 2020

QilongTang approved these changes Sep 10, 2020

View reviewed changes

aparajit-pratap requested changes Sep 10, 2020

View reviewed changes

src/DynamoCore/BuiltInAndOperators/BuiltIn.xml Outdated Show resolved Hide resolved

src/DynamoCore/BuiltInAndOperators/BuiltIn.xml Outdated Show resolved Hide resolved

martinstacey added 2 commits September 21, 2020 12:20

List.GroupByFunction search update

f0591d0

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

List.GroupByFunction Update output description

368caca

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

martinstacey requested a review from aparajit-pratap September 23, 2020 08:05

Amoursol self-requested a review September 30, 2020 15:36

Amoursol approved these changes Sep 30, 2020

View reviewed changes

aparajit-pratap previously approved these changes Oct 1, 2020

View reviewed changes

List.LaceShortest, List.LaceLongest, List.Combine, List.CartesionProd…

d5ab208

…uct update input name combinator -> combineFunction

List.GroupByFunction update output description

d7ecef5

>type: var[]..[] (list of arbitrary rank/levels) to List of arbitrary rank/levels (type: var[]..[])

aparajit-pratap merged commit 3e50feb into DynamoDS:master Oct 6, 2020

martinstacey deleted the DynamoCoreAnnotations branch December 3, 2020 12:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Dynamo core annotations 1-10 #11103

Dynamo core annotations 1-10 #11103

Uh oh!

martinstacey commented Sep 10, 2020 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Amoursol commented Sep 21, 2020

Uh oh!

Amoursol commented Sep 30, 2020

Uh oh!

aparajit-pratap commented Oct 1, 2020

Uh oh!

martinstacey commented Oct 5, 2020

Uh oh!

Uh oh!

Dynamo core annotations 1-10 #11103

Dynamo core annotations 1-10 #11103

Uh oh!

Conversation

martinstacey commented Sep 10, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Purpose

Declarations

Reviewers

FYIs

Uh oh!

Uh oh!

Uh oh!

Amoursol commented Sep 21, 2020

Uh oh!

Amoursol commented Sep 30, 2020

Uh oh!

aparajit-pratap commented Oct 1, 2020

Uh oh!

martinstacey commented Oct 5, 2020

Uh oh!

Uh oh!

martinstacey commented Sep 10, 2020 •

edited

Loading