Node Annotation Update: CoreNodes.FileSystem #11411
Merged
mmisol merged 6 commits intoDynamoDS:masterfrom Jan 29, 2021
Merged
Conversation
Description was producing errors, was remade
Contributor
|
LGTM @martinstacey ! |
mmisol
reviewed
Jan 28, 2021
Collaborator
mmisol
left a comment
There was a problem hiding this comment.
@martinstacey Added some comments. Please address when possible. Thanks!
mmisol
reviewed
Jan 29, 2021
Collaborator
mmisol
left a comment
There was a problem hiding this comment.
Thanks @martinstacey . Let's keep the comments for void functions as they are. Other than that there are two minor things left to fix.
mmisol
approved these changes
Jan 29, 2021
Collaborator
mmisol
left a comment
There was a problem hiding this comment.
Thanks @martinstacey . This one looks good too
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 CoreNodes.FileSystem
NODE 234 : Image.ReadFromFile
Description Input: File object to load image from. -> File object to load image from
Description Output: Image -> Image object from file
NODE 235 : Image.Pixels
Description Input: The image to read. -> Image object to get pixel colors from
Description Output: Colors at the specified grid points. -> Colors at the specified grid points
NODE 236 : FileSystem.MoveDirectory
Description Input: string -> String representation of existing path
Description Input: string -> String representation of new path
Description Input: bool -> Toggle to overwrite existing files
Description Output: void -> Node performs a task, doesn’t produce an output
NODE 237 : FileSystem.GetDirectoryContents
Description: FileSystem.GetDirectoryContents (directory: var, searchString: string = "*") -> Will return a list of files and directories that are contained within a given directory. An optional searchString can be used to filter the results.
Description Input: var -> Directory to get contents of
Description Input: string -> Search string used to filter results.
Description Input: bool -> Set to true to include files and folders in subdirectories (recursive) or set to false to include results from top-level of given directory only.
Description Output: var -> Resulting files from query
Description Output: var -> Resulting directories from query
NODE 240 : FileSystem.DeleteFile
Description Input: -> File path to delete
Description Output: void -> Node performs a task, doesn’t produce an output
NODE 241 : FileSystem.DeleteDirectory
Description: Deletes a directory. -> Deletes a directory
Description Input: Path to a directory on disk. -> Path to a directory on disk
Description Output: void -> Node performs a task, doesn’t produce an output
NODE 242 : FileSystem.CopyFile
Description: Copies a file. -> Copies a file
Description Input: var -> File object to copy
Description Input: string -> String representation of destination path
Description Input: bool -> Toggle to overwrite existing files
Description Output: void -> Node performs a task, doesn’t produce an output
NODE 243 : FileSystem.CopyDirectory
Description: Copies a directory to a destination location. -> Copies a directory to a destination location
Description Input: Directory to copy. -> Directory to copy
Description Input: Destination of the copy operation on disk. -> Destination of the copy operation on disk
Description Input: bool -> Toggle to overwrite existing directory
Description Output: void -> Node performs a task, doesn’t produce an output
NODE 244 : FileSystem.AppendText
Description Output: void -> Node performs a task, doesn’t produce an output
NODE 377 : Image.FromPixels
Description Input: 2d rectangular list of colors representing the pixels. -> 2d rectangular list of colors representing the pixels
Description Output: -> Image from 2d list of pixels
NODE 378 : Image.FromPixels
Description Input: List of colors representing the pixels. -> List of colors representing the pixels
Description Output: -> Image from list of pixels
NODE 379 : FileSystem.FileHasExtension
Description Input: Path to check for an extension. -> Path to check for an extension
Description Output: -> True if file path contains extension, false if it doesn't
NODE 380 : FileSystem.FileExtension
Description Input: Path to get extension of. -> Path to get extension of
Description Output: -> Extension of file
NODE 381 : FileSystem.FileExists
Description Input: string -> String representing a file path
Description Output: bool -> True if file exists, false if it doesn't
NODE 382 : FileSystem.DirectoryName
Description Input: Path to get directory information of. -> Path to get directory information of
Description Output: string -> Directory name of file path
NODE 383 : FileSystem.DirectoryExists
Description Input: Path to a directory on disk. -> Path to a directory on disk
Description Output: bool -> True if directory exists, false if it doesn’t
NODE 384 : FileSystem.CombinePath
Description Input: String to combine into a path. -> String to combine into a path
Description Output: string -> Combined file path
NODE 385 : FileSystem.ChangePathExtension
Description Input: Path to change extension of. -> Path to change extension of
Description Input: New extension. -> String representation of new extension
Description Output: string -> File path with changed extension
NODE 548 : FileSystem.FileName
Description Input: Path to get the file name of. -> Path to get the file name of
Description Input: Determines whether or not the extension is included in the result, defaluts to true. -> Toggle to include extension in result
Description Output: -> File name from file path
Reviewers
@Amoursol @aparajit-pratap @QilongTang