Skip to content

Node Annotation Update: CoreNodeModels.ColorRange, BuiltInOperators.Operators, and BuiltInOperators.BuiltIn#11389

Merged
mmisol merged 15 commits intoDynamoDS:masterfrom
martinstacey:Node-Annotation-UnitTypes-Operators-ColorRange
Jan 29, 2021
Merged

Node Annotation Update: CoreNodeModels.ColorRange, BuiltInOperators.Operators, and BuiltInOperators.BuiltIn#11389
mmisol merged 15 commits intoDynamoDS:masterfrom
martinstacey:Node-Annotation-UnitTypes-Operators-ColorRange

Conversation

@martinstacey
Copy link
Contributor

Purpose

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

This corrections are for CoreNodeModels.ColorRange, BuiltInOperators.Operators, and BuiltInOperators.BuiltIn

NODE 142 : ==
Description: Equal x to y? -> Compares if x and y are equal
Description Input: x value. -> Integer or double value
Description Input: y value. -> Integer or double value
Output: var[]..[] -> bool
Description Output: var[]..[] -> Result of equality check

NODE 143 : <=
Description: x less or equals y? -> If the x input is less than the y input, or if the two values are equal, it will return true. If x is greater than y, this operator will return false.
Description Input: x value. -> Integer or double value
Description Input: y value. -> Integer or double value
Output: var[]..[] -> bool
Description Output: var[]..[] -> Result of check

NODE 144 : <
Description: x less y? -> If the x input is less than the y input, it will return true. If x is greater than y, or if the two value are equal, this operator will return false.
Description Input: x value. -> Integer or double value
Description Input: y value. -> Integer or double value
Output: var[]..[] -> bool
Description Output: var[]..[] -> Result of check

NODE 145 : +
Description: adds x to y -> Returns addition of x and y
Description Input: x value. -> Integer or double value
Description Input: y value. -> Integer or double value
Output: var[]..[] -> number
Description Output: var[]..[] -> The sum of the two input numbers

NODE 146 : %
Description: finds the remainder of x/y -> Modulo: Finds the remainder of x/y
Description Input: x value. -> Integer or double value
Description Input: y value. -> Integer or double value
Output: var[]..[] -> number
Description Output: var[]..[] -> Remainder of the x input after being divided by the y input

NODE 147 : &&
Description: x and y? -> It takes two boolean values as input and returns true if both values are true.
Description Input: x value. -> A boolean to check if true
Description Input: y value. -> Another boolean to check if true
Output: var[]..[] -> bool
Description Output: var[]..[] -> Result of check

NODE 148 : /
Description: Divides x by y. -> Returns division of x over y
Description Input: x value. -> Integer or double value
Description Input: y value. -> Integer or double value
Output: var[]..[] -> double
Description Output: var[]..[] -> Result of division

NODE 149 : x
Description: Multiplies x by y. -> Returns multiplication of x times y
Description Input: x value. -> Integer or double value
Description Input: y value. -> Integer or double value
Output: var[]..[] -> number
Description Output: var[]..[] -> The product of the two input numbers

NODE 150 : !=
Description: x doesn’t equal y -> It takes two input values and returns true if the two values are not equal to each other and returns false if the two values are equal.
Description Input: x value. -> Integer or double value
Description Input: y value. -> Integer or double value
Output: var[]..[] -> bool
Description Output: var[]..[] -> Result of check

NODE 151 : -
Description: x substract y -> Returns subtraction of x minus y
Description Input: x value. -> Integer or double value
Description Input: y value. -> Integer or double value
Output: var[]..[] -> number
Description Output: var[]..[] -> Result of the y input subtracted from the x input

NODE 351 : ||
Description: x||y? -> Logical or operator
Description Input: x value. -> Boolean to check if true
Description Input: y value. -> Other boolean to check if true
Output: var[]..[] -> bool
Description Output: var[]..[] -> True if any of the inputs are true

NODE 352 : >=
Description: x greater or equals y? -> Compares if x is greater or equals to y
Description Input: x value. -> Integer or double value
Description Input: y value. -> Integer or double value
Output: var[]..[] -> bool
Description Output: var[]..[] -> True if x is equal or greater than y, false if not

NODE 353 : >
Description: x greater y? -> Compares if x is greater than y
Description Input: x value. -> Integer or double value
Description Input: y value. -> Integer or double value
Output: var[]..[] -> bool
Description Output: var[]..[] -> True if x is greater than y, false if not

NODE 354 : '==(tolerance)
Description Input: Tolerance -> Tolerance permited for equality check

NODE 128 : Color Range
Description Input: A list of values between 0.0 and 1.0 which position the input colors along the range. -> List of values between 0.0 and 1.0 which position the input colors along the range
Description Input: A list of values between 0.0 and 1.0. These values are used to loop up the color within the range. -> List of values between 0.0 and 1.0. These values define the colors that are picked along the color range to create the color list.
Description Output: The selected colors -> Selected colors

FYI

I am unable to find where the OR operator inputs names are defined.
I would make these changes on the input names:
Input: x -> bool
Input: y -> otherBool

image

Reviewers

@Amoursol @aparajit-pratap @QilongTang

@Amoursol
Copy link
Contributor

Regarding Node 142 (==) @martinstacey - There are two nodes now. One is strictly numbers and contains a tolerance input. The other also allows for other equality operations, so shouldn't only call out numbers and will need amending of the all ports / descriptions.

image

@Amoursol
Copy link
Contributor

Node 145 (+): This node covers both numerical operations, but also concatenation, as shown below: Can we please also call out this?

image

@Amoursol
Copy link
Contributor

Node 150 (!=) also takes in non-number inputs to check, as shown below 😊

image

@Amoursol
Copy link
Contributor

Amoursol commented Jan 11, 2021

For:

NODE 128 : Color Range
Description Input: A list of values between 0.0 and 1.0 which position the input colors along the range. -> List of values between 0.0 and 1.0 which position the input colors along the range
Description Input: A list of values between 0.0 and 1.0. These values are used to loop up the color within the range. -> List of >values between 0.0 and 1.0. These values define the colors that are picked along the color range to create the color list.
Description Output: The selected colors -> Selected colors

I'm unsure what this is changing, just the description for the overall node? Or also the inputs of "Color" / "Indices" / "value" ?

Descriptions changed to include all comparable types that are available for inputs
@martinstacey
Copy link
Contributor Author

martinstacey commented Jan 14, 2021

Comments on nodes 142, 145 and 150 were addressed in 55c3352, I did a few more experiments to be sure I include all data types available in the descriptions of the inputs.

image

@martinstacey
Copy link
Contributor Author

For:

NODE 128 : Color Range
Description Input: A list of values between 0.0 and 1.0 which position the input colors along the range. -> List of values between 0.0 and 1.0 which position the input colors along the range
Description Input: A list of values between 0.0 and 1.0. These values are used to loop up the color within the range. -> List of >values between 0.0 and 1.0. These values define the colors that are picked along the color range to create the color list.
Description Output: The selected colors -> Selected colors

I'm unsure what this is changing, just the description for the overall node? Or also the inputs of "Color" / "Indices" / "value" ?

These were really small changes made to the sentence structure of some nodes to make them less verbose and coherent with other descriptions. I basically tried to avoid using determiners before each input description to avoid repeating the word “the” or “a” before every description.

image

@Amoursol
Copy link
Contributor

For:

NODE 128 : Color Range
Description Input: A list of values between 0.0 and 1.0 which position the input colors along the range. -> List of values between 0.0 and 1.0 which position the input colors along the range
Description Input: A list of values between 0.0 and 1.0. These values are used to loop up the color within the range. -> List of >values between 0.0 and 1.0. These values define the colors that are picked along the color range to create the color list.
Description Output: The selected colors -> Selected colors

I'm unsure what this is changing, just the description for the overall node? Or also the inputs of "Color" / "Indices" / "value" ?

These were really small changes made to the sentence structure of some nodes to make them less verbose and coherent with other descriptions. I basically tried to avoid using determiners before each input description to avoid repeating the word “the” or “a” before every description.

image

Ah brilliant, got it! Thanks @martinstacey

@Amoursol
Copy link
Contributor

Comments on nodes 142, 145 and 150 were addressed in 55c3352, I did a few more experiments to be sure I include all data types available in the descriptions of the inputs.

image

Awesome, thank you very much @martinstacey 😊

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.

Hi @martinstacey . I took a look and found some minor things that could be improved. Please take a look whenever you can. Thanks!

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.

Looks good! Thanks @martinstacey

@mmisol mmisol merged commit f8ef76b 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