Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dynamo core annotations 1-10 #11103

Merged
merged 12 commits into from
Oct 6, 2020

Conversation

martinstacey
Copy link
Contributor

@martinstacey martinstacey commented Sep 10, 2020

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

image

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
@martinstacey martinstacey changed the title Dynamo core annotations Dynamo core annotations 1-10 Sep 10, 2020
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
Copy link
Contributor

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

@Amoursol
Copy link
Contributor

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

aparajit-pratap
aparajit-pratap previously approved these changes Oct 1, 2020
@aparajit-pratap aparajit-pratap dismissed their stale review October 1, 2020 16:29

Some review comments are yet to be addressed.

@aparajit-pratap
Copy link
Contributor

@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
Copy link
Contributor Author

@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[]..[])
@aparajit-pratap aparajit-pratap merged commit 3e50feb into DynamoDS:master Oct 6, 2020
@martinstacey martinstacey deleted the DynamoCoreAnnotations branch December 3, 2020 12:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants