Node consistency 11 20 #11104

martinstacey · 2020-09-10T10:21:22Z

Purpose

The following PR addresses nodes' names and descriptions to make them more descriptive for beginners.

12) NODE: Web Request
-CHANGES: Output result to string. Input Description: The url for the web request as a string. Output Description: Content of a web request as a string.

13) NODE: CoordinateSystem.Rotate(coordinateSystem,plane,drees)
-FYI: Node’s description is inside Protogeometry.dll should be changed by Autodesk

14) NODE: Color.Saturation
-CHANGES: Output saturation to double. Output Description: Saturation value as double between 0 and 1 inclusive.

15) NODE: Thread.Pause
CHANGES:
-Rename x in input and output to object.

16) NODE: Convert Between Units
NO CHANGES

17) NODE: Not
CHANGES: Description: Reverses the result, returns false if the result is true
Input Description: boolean to reverse
Output: x to boolean
Output Description: reversed boolean
-FYI: Input could not be changed from x to boolean, Autodesk should change in not reference.

18) NODE: Or
CHANGES: Input: bool0 to boolean0 Output empty to boolean Description: boolean to reverse
Input Description operand to Boolean #0...

19) NODE: And
CHANGES: Input: bool0 to boolean0 Output empty to boolean Description: boolean to reverse
Input Description operand to Boolean #0...

20) NODE: List.MinimumItemByKey
Output: minimumItem
Output Description: minimum item in list using keyFunction

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

Node CoordinateSystem.Rotate: Node’s description is inside Protogeometry.dll should be changed by Autodesk
Node Not: Input could not be changed from x to boolean, Autodesk should change in not reference.

**NODE: Web Request** -CHANGES: Output result to string. Input Description: The url for the web request as a string., Output Description: Content of a webpage as a string. -NOT APPLICABLE: Name has spaces, does not have DS Syntax

**NODE: Color.Saturation** -CHANGES: Output saturation to double. Output Description: Saturation value as double between 0 and 1 inclusive.

**NODE: Thread.Pause** CHANGES: -Rename x in input and output to object.

**NODE: Not** CHANGES: Description: Reverses the result, returns false if the result is true Input Description: boolean to reverse UNABLE TO DO: Input: x to boolean Output: var[]..[] to boolean Output Description: reversed boolean

**NODE: Or** CHANGES: Input: bool0 to boolean0 Output empty to boolean Description: boolean to reverse Input Description operand to Boolean #0... **NODE: And** CHANGES: Input: bool0 to boolean0 Output empty to boolean Description: boolean to reverse Input Description operand to Boolean #0...

Not output:boolean Output description reversed boolean

20) NODE: List.MinimumItemByKey Output: minItem Output Description: minimum item in list using keyProjector

Content of a webpage as a string. to Content of a web request as a string.

Output changed from minItem to minimumItem

Amoursol · 2020-09-10T16:59:23Z

@martinstacey Please provide improvement suggestions for all the nodes that are locked into ProtoGeometry behind ADSK VPN.

src/DynamoCore/BuiltInAndOperators/BuiltIn.xml

src/DynamoCore/BuiltInAndOperators/Operators.xml

src/Libraries/CoreNodeModels/Logic/AndOr.cs

src/DynamoCore/BuiltInAndOperators/Operators.xml

Update output to reflect datatype: type: var[]..[] (minimum item in list using keyProjector)

Not Node description updated: Negates the input, e.g. returns false when the input is true.

Changed from boolean to bool to use DesignScript base type abbreviations

Inlcude type in output description

martinstacey · 2020-09-21T16:16:58Z

@martinstacey Please provide improvement suggestions for all the nodes that are locked into ProtoGeometry behind ADSK VPN.

@Amoursol

Suggestions for nodes locked in protogeometry:

CoordinateSystem.Rotate(coordinateSystem,plane,degrees)
-Node Description: Rotates a coordinate system on a plane by a specified degree
-Input Name: coordinateSystem
-Input Description coordinateSystem: a coordinate system
-Output Description coordinateSystem: rotated coordinate system

Not
-Input name: bool
-Input description: Boolean to reverse

Amoursol · 2020-09-21T17:20:49Z

@martinstacey Please provide improvement suggestions for all the nodes that are locked into ProtoGeometry behind ADSK VPN.

@Amoursol

Suggestions for nodes locked in protogeometry:

CoordinateSystem.Rotate(coordinateSystem,plane,degrees)
-Node Description: Rotates a coordinate system on a plane by a specified degree
-Input Name: coordinateSystem
-Input Description coordinateSystem: a coordinate system
-Output Description coordinateSystem: rotated coordinate system

Not
-Input name: bool
-Input description: Boolean to reverse

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

input name: keyProjector -> keyFunction new output description: type: var[]..[] (minimum item in list using keyFunction)

Amoursol · 2020-09-30T15:26:08Z

@martinstacey please change 'keyProjector' to 'keyFunction' for List.MinimumItemByKey, after that LGTM. @aparajit-pratap when keyFunction fix implemented it's good to close from my side.

src/Libraries/CoreNodeModels/Logic/AndOr.cs

aparajit-pratap · 2020-10-01T16:39:09Z

@martinstacey I see two test failures as a result of these changes:

Dynamo.PackageManager.Tests.PackageLoaderTests.LoadingCustomNodeFromPackageSetsNodeInfoPackageInfoCorrectly
Dynamo.PackageManager.Tests.PackageLoaderTests.PlacingCustomNodeInstanceFromPackageRetainsCorrectPackageInfoState

Let us know if you need help fixing these tests before we can merge this PR.

Change boolean to bool

martinstacey · 2020-10-05T09:22:32Z

@martinstacey I see two test failures as a result of these changes:
Dynamo.PackageManager.Tests.PackageLoaderTests.LoadingCustomNodeFromPackageSetsNodeInfoPackageInfoCorrectly
Dynamo.PackageManager.Tests.PackageLoaderTests.PlacingCustomNodeInstanceFromPackageRetainsCorrectPackageInfoState
Let us know if you need help fixing these tests before we can merge this PR.

@aparajit-pratap

I ran these tests on my computer and had no issues. I just did an update on 29402fa, I hope this reruns and passes the tests.

type: var[]..[] (minimum item in list using keyFunction) to Minimum item in list using keyFunction (type: var[]..[])

martinstacey added 9 commits September 2, 2020 17:02

Web Request Annotations Update

3a74511

**NODE: Web Request** -CHANGES: Output result to string. Input Description: The url for the web request as a string., Output Description: Content of a webpage as a string. -NOT APPLICABLE: Name has spaces, does not have DS Syntax

Color.Saturation Annotation Update

1e79aa6

**NODE: Color.Saturation** -CHANGES: Output saturation to double. Output Description: Saturation value as double between 0 and 1 inclusive.

Thre

154c385

**NODE: Thread.Pause** CHANGES: -Rename x in input and output to object.

Not Annotation Update

121507f

**NODE: Not** CHANGES: Description: Reverses the result, returns false if the result is true Input Description: boolean to reverse UNABLE TO DO: Input: x to boolean Output: var[]..[] to boolean Output Description: reversed boolean

Not output and output description added

68283ec

Not output:boolean Output description reversed boolean

List.MinimumItemByKey Annotation Update

63b3ae3

20) NODE: List.MinimumItemByKey Output: minItem Output Description: minimum item in list using keyProjector

WebRequest description changed

d5247d3

Content of a webpage as a string. to Content of a web request as a string.

MinimumItemByKey update Output

b8dc25c

Output changed from minItem to minimumItem

Amoursol requested review from Amoursol and QilongTang September 10, 2020 16:45

aparajit-pratap reviewed Sep 10, 2020

View reviewed changes

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

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

src/Libraries/CoreNodeModels/Logic/AndOr.cs Outdated Show resolved Hide resolved

aparajit-pratap reviewed Sep 11, 2020

View reviewed changes

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

martinstacey added 4 commits September 21, 2020 12:54

List.MinimumItemByKey update output description

1d53fd1

Update output to reflect datatype: type: var[]..[] (minimum item in list using keyProjector)

Not update description

209bb6c

Not Node description updated: Negates the input, e.g. returns false when the input is true.

Not, And,Or Nodes output + input name updated

9e1a3c0

Changed from boolean to bool to use DesignScript base type abbreviations

Not node output description updated

2b6a2d7

Inlcude type in output description

List.MinimumItemByKey update input name, and output description

0f91a75

input name: keyProjector -> keyFunction new output description: type: var[]..[] (minimum item in list using keyFunction)

Amoursol approved these changes Sep 30, 2020

View reviewed changes

aparajit-pratap reviewed Oct 1, 2020

View reviewed changes

src/Libraries/CoreNodeModels/Logic/AndOr.cs Outdated Show resolved Hide resolved

And & Or input update

29402fa

Change boolean to bool

List.MinimumItemByKey Output description updated

65266ef

type: var[]..[] (minimum item in list using keyFunction) to Minimum item in list using keyFunction (type: var[]..[])

aparajit-pratap merged commit 5c37318 into DynamoDS:master Oct 6, 2020

martinstacey deleted the Node-Consistency-11-20 branch December 3, 2020 12:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Node consistency 11 20 #11104

Node consistency 11 20 #11104

martinstacey commented Sep 10, 2020 •

edited

Loading

Amoursol commented Sep 10, 2020

martinstacey commented Sep 21, 2020

Amoursol commented Sep 21, 2020

Amoursol commented Sep 30, 2020

aparajit-pratap commented Oct 1, 2020

martinstacey commented Oct 5, 2020

Node consistency 11 20 #11104

Node consistency 11 20 #11104

Conversation

martinstacey commented Sep 10, 2020 • edited Loading

Purpose

Declarations

Reviewers

FYIs

Amoursol commented Sep 10, 2020

martinstacey commented Sep 21, 2020

Amoursol commented Sep 21, 2020

Amoursol commented Sep 30, 2020

aparajit-pratap commented Oct 1, 2020

martinstacey commented Oct 5, 2020

martinstacey commented Sep 10, 2020 •

edited

Loading