Skip to content

Node Annotation Update: DSOffice.Excel and DynamoUnits.Location#11388

Merged
QilongTang merged 8 commits intoDynamoDS:masterfrom
martinstacey:Node-Annotation-Update-Excel-CodeBlock-Location
Jan 26, 2021
Merged

Node Annotation Update: DSOffice.Excel and DynamoUnits.Location#11388
QilongTang merged 8 commits intoDynamoDS:masterfrom
martinstacey:Node-Annotation-Update-Excel-CodeBlock-Location

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 their location in DynamoDS.

These corrections are for DSOffice.Excel, and DynamoUnits.Location

NODE 221 : Location.Name
Description: Location.Name -> Gets the name value from a location
Description Output: string -> Name of location

NODE 222 : Location.Longitude
Description: Location.Longitude -> The Location's Longitude in degrees between -180.0 and 180.0
Description Output: double -> Longitude geographic coordinate of location

NODE 223 : Location.Latitude
Description: Location.Latitude -> The Location's latitude in degrees between -90.0 and 90
Description Output: double -> Latitude geographic coordinate of location

NODE 245 : Data.ExportExcel
Description Input: File path to the Microsoft Excel spreadsheet. -> File path to the Excel spreadsheet
Description Input: Name of the worksheet to write data to. -> Name of the spreadsheet to write data to
Description Input: -> Toggle to clear spreadsheet before writing
Description Input: Toggle to switch between writing Excel file as strings. -> Toggle to switch between writing Excel file as strings
Description Output: Data written to the spreadsheet. -> Data written to the spreadsheet

NODE 372 : Location.ByLatitudeAndLongitude
Description: Location.ByLatitudeAndLongiture (latitude: double, longitude:double name:string) -> Create a Location object by specifying a latitude and a longitude.
Description Input: double -> Angle, in degrees, between -90.0 and 90.0
Description Input: double -> Angle, in degrees, between -180.0 and 180.0
Description Input: string -> A name for the location
Description Output: Location -> Location object

NODE 386 : Data.ImportExcel
Description Input: File representing the Microsoft Excel spreadsheet. -> File representing the Excel spreadsheet
Description Input: Name of the worksheet containing data. -> Name of the spreadsheet containing data
Description Input: Toggle to swhich between reading Excel file as strings. -> Toggle to read cells as strings
Description Input: Toggle to switch between showing and hiding the main Excel window -> Toggle to show excel's main window
Description Output: Rows of data from the Excel worksheet. -> Rows of data from the Excel spreadsheet

NODE 387 : Data.ImportCSV
Description Input: The CSV file to be converted into a list. -> CSV file to be converted into a list
Description Input: Whether the resulting list should be transposed. -> Toggle to transpose the imported data
Description Output: The list containing the items in the CSV file. -> List containing the items in the CSV file

FYI

For nodes location.name, location.longitude, and location.latitude :
These nodes are using a property (longitude,location,latitude) of class location, so I do not know how to change the description for input location. I would make these changes to the inputs descriptions:
Description Input: DynamoUnits.Location -> Location to query name from
Description Input: DynamoUnits.Location -> Location to query latitude from
Description Input: DynamoUnits.Location -> Location to query longitude from

image

Reviewers

@Amoursol @aparajit-pratap @QilongTang

@Amoursol
Copy link
Contributor

Hi @martinstacey - A few comments:

For NODE 245: Data.ExportToExcel - Please revert back to the term worksheet instead of spreadsheet for the "Name of the spreadsheet to write data to" portion as users could get confused. The overall Excel workbook is a collection of these worksheets. Spreadsheet is a collective term and not excel specific - a quick explanation is here: https://magoosh.com/excel/difference-excel-workbook-vs-excel-sheets/#:~:text=The%20worksheet%20is%20single%20page,a%20complete%20book%20(workbook).

Changes:
Description Input: File representing the Microsoft Excel spreadsheet. -> File representing the Excel workbook
Description Input: Name of the worksheet containing data. -> Name of the worksheet containing data
Description Output: Rows of data from the Excel worksheet. -> Rows of data from the Excel worksheet

For NODE 386 : Data.ImportExcel - Ditto:

Description Input: File representing the Microsoft Excel spreadsheet. -> File representing the Excel workbook
Description Input: Name of the worksheet containing data. -> Name of the worksheet containing data
Description Output: Rows of data from the Excel worksheet. -> Rows of data from the Excel worksheet

Differentiate between excel’s workbook, worksheet and spreadsheet.
@martinstacey
Copy link
Contributor Author

Hi @martinstacey - A few comments:

For NODE 245: Data.ExportToExcel - Please revert back to the term worksheet instead of spreadsheet for the "Name of the spreadsheet to write data to" portion as users could get confused. The overall Excel workbook is a collection of these worksheets. Spreadsheet is a collective term and not excel specific - a quick explanation is here: https://magoosh.com/excel/difference-excel-workbook-vs-excel-sheets/#:~:text=The%20worksheet%20is%20single%20page,a%20complete%20book%20(workbook).

Changes:
Description Input: File representing the Microsoft Excel spreadsheet. -> File representing the Excel workbook
Description Input: Name of the worksheet containing data. -> Name of the worksheet containing data
Description Output: Rows of data from the Excel worksheet. -> Rows of data from the Excel worksheet

For NODE 386 : Data.ImportExcel - Ditto:

Description Input: File representing the Microsoft Excel spreadsheet. -> File representing the Excel workbook
Description Input: Name of the worksheet containing data. -> Name of the worksheet containing data
Description Output: Rows of data from the Excel worksheet. -> Rows of data from the Excel worksheet

addressed in 49388b6

@QilongTang QilongTang merged commit f6d3107 into DynamoDS:master Jan 26, 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