Skip to content

Node Annotation Update: CoreNodeModels MapCombineLacing DesignScriptBuiltIn.Dictionary#11424

Merged
mmisol merged 4 commits intoDynamoDS:masterfrom
martinstacey:Noda-Annotations-MapCombineLacing-Others
Jan 29, 2021
Merged

Node Annotation Update: CoreNodeModels MapCombineLacing DesignScriptBuiltIn.Dictionary#11424
mmisol merged 4 commits intoDynamoDS:masterfrom
martinstacey:Noda-Annotations-MapCombineLacing-Others

Conversation

@martinstacey
Copy link
Contributor

@martinstacey martinstacey commented Jan 22, 2021

Purpose

The following PR addresses nodes' names and descriptions to make them more descriptive for beginners, PRs are organized according to location in DynamoDS.

These corrections are for CoreNodeModels.MapCombineLacing and DesignScriptBuiltIn.Dictionary

NODE 177 : ReplaceByCondition
Description Input: Predicate used to determine if it should be replaced -> Replacement function used to determine if an object should be replaced
Description Output: If condition(item) = True, then replaceWith is returend. Otherwise item is returned unaltered -> Item, or list with items replaced by condition

NODE 183 : List.Filter
Description Input: Predicate used to determine if an element is filtered in or out. -> Filter function used to determine if an element is filtered in our out

NODE 129 : Dictionary.Components
Description Output: The keys of the dictionary -> Keys of the dictionary
Description Output: The values of the dictionary -> Values of the dictionary

NODE 344 : Dictionary.Values
Description Output: The values of the Dictionary. -> Values of the dictionary

NODE 345 : Dictionary.Keys
Description Output: The keys of the Dictionary -> Keys of the dictionary

NODE 346 : Dictionary.ValueAtKey
Description Input: The key in the Dictionary to obtain. -> The key in the dictionary to obtain value
Description Output: The value at the specified key or null if it is not set. -> Value at the specified key or null if it is not set

NODE 347 : Dictionary.SetValueAtKeys
Description Output: A new Dictionary with the entries inserted -> New dictionary with the entries inserted

NODE 530 : Dictionary.Count
Description Output: int -> Number of key value pairs in dictionary

NODE 531 : Dictionary.RemoveKeys
Description Input: The key in the Dictionary to remove -> Keys to remove
Description Output: A new Dictionary with the key removed -> New dictionary with keys removed

NODE 532 : Dictionary.ByKeysValues
Description Input: The string keys of the Dictionary -> Keys of dictionary
Description Input: The values of the Dictionary -> Values of dictionary
Description Output: The result Dictionary -> Dictionary from keys and values

FYI

For nodes Dictionary.Components, Dictionary.Values, Dictionary.Keys, Dictionary.ValueAtKey, Dictionary.SetValueAtKeys, Dictionary.Count, Dictionary.RemoveKeys, Dictionary.ByKeysValues These nodes are using a property of class Dictionary, so I do not know how to change the description for input location. I would make these changes to the inputs descriptions:
Description Input: DesignScript.Builtin.Dictionary -> Dictionary to extract components from
Description Input: DesignScript.Builtin.Dictionary -> Dictionary to query values from
Description Input: DesignScript.Builtin.Dictionary -> Dictionary to query value at key from
Description Input: DesignScript.Builtin.Dictionary -> Dictionary to set value at key
Description Input: DesignScript.Builtin.Dictionary -> Dictionary to query keys from
Description Input: DesignScript.Builtin.Dictionary -> Dictionary to count number of key value pairs from
Description Input: DesignScript.Builtin.Dictionary -> Dictionary to remove keys from

image

Reviewers

@Amoursol @aparajit-pratap @QilongTang

Copy link
Collaborator

@mmisol mmisol left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@martinstacey Added some minor comments. Please take a look. Thanks!

@martinstacey
Copy link
Contributor Author

@martinstacey Added some minor comments. Please take a look. Thanks!

Thanks @mmisol! will have a look at the comments.

Copy link
Collaborator

@mmisol mmisol left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for addressing the changes @martinstacey . Looks good to me

@mmisol mmisol merged commit dfd5a27 into DynamoDS:master Jan 29, 2021
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.

3 participants