Fix lies in the return annotations

Resolves cakephp/docs/#4715
cakephp · Feb 16, 2017 · 3860835 · 3860835
1 parent e4585da
commit 3860835
Showing 1 changed file with 6 additions and 6 deletions.
diff --git a/src/View/Helper/TimeHelper.php b/src/View/Helper/TimeHelper.php
@@ -86,35 +86,35 @@ public function nice($dateString = null, $timezone = null, $locale = null)
     }
 
     /**
-     * Returns true if given datetime string is today.
+     * Returns true, if the given datetime string is today.
      *
      * @param int|string|\DateTime $dateString UNIX timestamp, strtotime() valid string or DateTime object
      * @param string|\DateTimeZone|null $timezone User's timezone string or DateTimeZone object
-     * @return bool True if datetime string is today
+     * @return bool True if the given datetime string is today.
      */
     public function isToday($dateString, $timezone = null)
     {
         return (new Time($dateString, $timezone))->isToday();
     }
 
     /**
-     * Returns true if given datetime string is in the future.
+     * Returns true, if the given datetime string is in the future.
      *
      * @param int|string|\DateTime $dateString UNIX timestamp, strtotime() valid string or DateTime object
      * @param string|\DateTimeZone|null $timezone User's timezone string or DateTimeZone object
-     * @return bool True if datetime string is today
+     * @return bool True if the given datetime string lies in the future.
      */
     public function isFuture($dateString, $timezone = null)
     {
         return (new Time($dateString, $timezone))->isFuture();
     }
 
     /**
-     * Returns true if given datetime string is in the past.
+     * Returns true, if the given datetime string is in the past.
      *
      * @param int|string|\DateTime $dateString UNIX timestamp, strtotime() valid string or DateTime object
      * @param string|\DateTimeZone|null $timezone User's timezone string or DateTimeZone object
-     * @return bool True if datetime string is today
+     * @return bool True if the given datetime string lies in the past.
      */
     public function isPast($dateString, $timezone = null)
     {