summaryrefslogtreecommitdiffstats
path: root/src/timetype.rs
diff options
context:
space:
mode:
authorMatthias Beyer <mail@beyermatthias.de>2017-09-16 12:40:27 +0200
committerMatthias Beyer <mail@beyermatthias.de>2017-09-16 12:40:27 +0200
commit93418a6a5b70d5c0dcf1b509fa54d675558196da (patch)
tree05d6f5612d57c4b155afe3204d52493d8153bf76 /src/timetype.rs
parent3a4b2bde8056339744372757e1fed4bf15cf3302 (diff)
Add additional comment to TimeType::end_of_* functions
Diffstat (limited to 'src/timetype.rs')
-rw-r--r--src/timetype.rs10
1 files changed, 10 insertions, 0 deletions
diff --git a/src/timetype.rs b/src/timetype.rs
index 05d9015..91302fc 100644
--- a/src/timetype.rs
+++ b/src/timetype.rs
@@ -166,6 +166,8 @@ impl TimeType {
/// Calculate the end of the year based on the current TimeType
///
+ /// The end of a year is considered to be the last day of the year, not the last second.
+ ///
/// # Warning
///
/// If the current TimeType does _not_ evaluate to a `TimeType::Moment`, calculating the end of
@@ -177,6 +179,8 @@ impl TimeType {
/// Calculate the end of the month based on the current TimeType
///
+ /// The end of a month is considered to be the last day of the month, not the last second.
+ ///
/// # Warning
///
/// If the current TimeType does _not_ evaluate to a `TimeType::Moment`, calculating the end of
@@ -187,6 +191,8 @@ impl TimeType {
/// Calculate the end of the day based on the current TimeType
///
+ /// The end of a day is considered the last second of the day
+ ///
/// # Warning
///
/// If the current TimeType does _not_ evaluate to a `TimeType::Moment`, calculating the end of
@@ -197,6 +203,8 @@ impl TimeType {
/// Calculate the end of the hour based on the current TimeType
///
+ /// The end of a hour is considered the last second of a hour
+ ///
/// # Warning
///
/// If the current TimeType does _not_ evaluate to a `TimeType::Moment`, calculating the end of
@@ -207,6 +215,8 @@ impl TimeType {
/// Calculate the end of the minute based on the current TimeType
///
+ /// The end of a minute is considered to be the last second of a minute
+ ///
/// # Warning
///
/// If the current TimeType does _not_ evaluate to a `TimeType::Moment`, calculating the end of