Skip to content

Node Annotation Update: CoreNodes.DateTime#11407

Merged
mmisol merged 4 commits intoDynamoDS:masterfrom
martinstacey:Node-Annotations-DateTime
Jan 29, 2021
Merged

Node Annotation Update: CoreNodes.DateTime#11407
mmisol merged 4 commits intoDynamoDS:masterfrom
martinstacey:Node-Annotations-DateTime

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.

These corrections are for CoreNodes.DateTime

NODE 214 : TimeSpan.Subtract
Description: Substracts two TimeSpans. -> Substracts two TimeSpans
Description Input: A TimeSpan -> TimeSpan to substract from
Description Input: A TimeSpan -> TimeSpan to substract
Description Output: TimeSpan -> Resulting TimeSpan from subtraction

NODE 215 : TimeSpan.Scale
Description: Multuplies a TimeSpan by a scaling factor. -> Multuplies a TimeSpan by a scaling factor
Description Input: A TimeSpan -> TimeSpan to multiply
Description Output: TimeSpan -> TimeSpan product

NODE 216 : TimeSpan.Negate
Description Input: A TimeSpan -> TimeSpan to negate
Description Output: TimeSpan -> Negative TimeSpan

NODE 217 : TimeSpan.FromString
Description: Attempts to parse a TimeSpan from a string. -> Attempts to parse a TimeSpan from a string
Input: str -> string
Description Output: TimeSpan -> TimeSpan from parsed string

NODE 218 : TimeSpan.ByDateDifference
Description: Yileds a new TimeSpan calculated from the time difference between two DateTimes. -> Yields a new TimeSpan calculated from the time difference between two DateTimes
Description Input: Starting DateTime. -> Starting DateTime
Description Input: EndingDateTime -> Ending DateTime
Description Output: TimeSpan -> TimeSpan difference between two dates

NODE 219 : TimeSpan.Add
Description: Add two TimeSpans. -> Add two TimeSpans
Description Input: A TimeSpan -> TimeSpan to add
Description Input: A TimeSpan -> Other TimeSpan to add
Description Output: TimeSpan -> Resulting TimeSpan from addition

NODE 224 : DateTime.SubtractTimeSpan
Description Input: Starting DateTime. -> Starting DateTime
Description Output: dateTime -> Resulting DateTime from substraction

NODE 225 : DateTime.IsLeapYear
Description: Determines if the given year is a leap year. -> Determines if the given year is a leap year
Description Output: bool -> True if year is leap year, false if not

NODE 226 : DateTime.IsDaylightSavingsTime
Description: Determines if it is Daylight Savings Time at the given DateTime. -> Determines if date time is in daylight saving time.
Description Input: A DateTime -> DateTime to determine if its daylight
Description Output: bool -> True if DateTime is in daylight saving time, false if it isn't

NODE 227 : DateTime.FromString
Description: Attempts to parse a DateTime from a string. -> Attempts to parse a DateTime from a string
Description Input: -> String representation of DateTime
Description Output: dateTime -> DateTime from parsed string

NODE 228 : DateTime.DayOfWeek
Description Input: A DateTime object. -> DateTime object to get week day from

NODE 229 : DateTime.Components
Description Input: A DateTime. -> DateTime to get components from
Description Output: var -> Numeric representation of the year (1-9999)
Description Output: var -> Numeric representation of the month (1-12)
Description Output: var -> Numeric representation of the day (1-[days in month])
Description Output: var -> Numeric representation of the hour (0-23)

NODE 230 : DateTime.ByDateAndTime
Description Output: dateTime -> DateTime created from date and time

NODE 231 : DateTime.ByDate
Description Output: dateTime -> DateTime created from date

NODE 232 : DateTime.AddTimeSpan
Description Input: -> Amount of time to add to DateTime
Description Output: dateTime -> Resulting DateTime from addition of timespan

NODE 366 : TimeSpan.TotalSeconds
Description Input: A TimeSpan -> TimeSpan to query total seconds from
Description Output: double -> Total amount of seconds

NODE 367 : TimeSpan.TotalMinutes
Description Input: A TimeSpan -> TimeSpan to query total minutes from
Description Output: double -> Total amount of minutes

NODE 368 : TimeSpan.TotalMilliseconds
Description Input: A TimeSpan -> TimeSpan to query total milliseconds from
Description Output: double -> Total amount of milliseconds

NODE 369 : TimeSpan.TotalHours
Description Input: A TimeSpan -> TimeSpan to query total total hours from
Description Output: double -> Total amound of hours

NODE 370 : TimeSpan.TotalDays
Description Input: A TimeSpan -> TimeSpan to query total days from
Description Output: double -> Total amound of days

NODE 371 : TimeSpan.Create
Description Output: A TimeSpan. -> TimeSpan created

NODE 373 : DateTime.DaysInMonth
Description Output: int -> Number of days in month

NODE 374 : DateTime.DayOfYear
Description Input: A DateTime. -> DateTime to get day of the year
Description Output: int -> Number of days from beginning of the year

NODE 536 : TimeSpan.Zero
Description Output: TimeSpan -> TimeSpan representing an elapsed time of zero

NODE 537 : TimeSpan.MinValue
Description Output: TimeSpan -> Minimum possible TimeSpan representation

NODE 538 : TimeSpan.MaxValue
Description Output: TimeSpan -> Maximum possible TimeSpan representation

NODE 539 : DateTime.Today
Description Output: DateTime -> DateTime representing today

NODE 540 : DateTime.Now
Description Output: DateTime -> DateTime representing the present time

NODE 541 : DateTime.MinValue
Description Output: -> Minimum possible DateTime representation

NODE 542 : DateTime.MaxValue
Description Output: -> Maximum possible TimeSpan representation

NODE 543 : DateTime.Format
Description Input: The DateTime to format. -> The DateTime to format
Description Output: -> DateTime represented as a string

image

Reviewers

@Amoursol @aparajit-pratap @QilongTang

@Amoursol
Copy link
Contributor

@martinstacey

NODE 226 : DateTime.IsDaylightSavingsTime
Description: Determines if it is Daylight Savings Time at the given DateTime. -> Determines if date time is in daylight saving time.
Description Input: A DateTime -> DateTime to determine if its daylight
Description Output: bool -> True if DateTime is in daylight saving time, false if it isn't

Input description feels incomplete - Can we change to "DateTime used to determine if there is daylight savings" or similar?

Rest look good!

@martinstacey
Copy link
Contributor Author

@martinstacey

NODE 226 : DateTime.IsDaylightSavingsTime
Description: Determines if it is Daylight Savings Time at the given DateTime. -> Determines if date time is in daylight saving time.
Description Input: A DateTime -> DateTime to determine if its daylight
Description Output: bool -> True if DateTime is in daylight saving time, false if it isn't

Input description feels incomplete - Can we change to "DateTime used to determine if there is daylight savings" or similar?

Rest look good!

Addressed in e5d4944

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 I found some minor issues. Please fix them when you can. Thanks!

@martinstacey
Copy link
Contributor Author

@martinstacey I found some minor issues. Please fix them when you can. Thanks!

Thanks, I addressed these issues on 06ff62e

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 @martinstacey . Looks good to me

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