From 4c30c8228bc64216f07c211ae5f824f59b4b8503 Mon Sep 17 00:00:00 2001
From: Oliver Booth <me@olivr.me>
Date: Sun, 19 Apr 2020 14:14:59 +0100
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=95=20Document=20return=20values=20in?=
 =?UTF-8?q?=20DateTimeExtensions?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 X10D/src/DateTimeExtensions.cs | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)

diff --git a/X10D/src/DateTimeExtensions.cs b/X10D/src/DateTimeExtensions.cs
index 4577b8b..d06bff8 100644
--- a/X10D/src/DateTimeExtensions.cs
+++ b/X10D/src/DateTimeExtensions.cs
@@ -22,7 +22,8 @@
         /// </summary>
         /// <param name="date">The date from which to start.</param>
         /// <param name="asOf">The date at which to stop counting.</param>
-        /// <returns>Returns the number of years since <paramref name="date"/> as of <paramref name="asOf"/>.</returns>
+        /// <returns>Returns the integer number of years since <paramref name="date"/> as of
+        /// <paramref name="asOf"/>.</returns>
         public static int Age(this DateTime date, DateTime asOf)
         {
             return (int)(((asOf.Date - TimeSpan.FromDays(1) - date.Date).TotalDays + 1) / 365.2425);
@@ -31,9 +32,9 @@
         /// <summary>
         /// Gets a DateTime representing the first occurence of a specified day in the current month.
         /// </summary>
-        /// <param name="current">The current day</param>
-        /// <param name="dayOfWeek">The current day of week</param>
-        /// <returns>Returns a date which representing the first occurence of <paramref name="dayOfWeek"/>.</returns>
+        /// <param name="current">The current day.</param>
+        /// <param name="dayOfWeek">The current day of week.</param>
+        /// <returns>Returns a date representing the first occurence of <paramref name="dayOfWeek"/>.</returns>
         public static DateTime First(this DateTime current, DayOfWeek dayOfWeek)
         {
             DateTime first = current.FirstDayOfMonth();
@@ -50,6 +51,7 @@
         /// Gets a <see cref="DateTime"/> representing the first day in the current month.
         /// </summary>
         /// <param name="current">The current date.</param>
+        /// <returns>Returns a date representing the first day of the month>.</returns>
         public static DateTime FirstDayOfMonth(this DateTime current)
         {
             return current.AddDays(1 - current.Day);
@@ -59,6 +61,7 @@
         /// Gets a <see cref="DateTime"/> representing the last day in the current month.
         /// </summary>
         /// <param name="current">The current date.</param>
+        /// <returns>Returns a date representing the last day of the month>.</returns>
         public static DateTime LastDayOfMonth(this DateTime current)
         {
             var daysInMonth = DateTime.DaysInMonth(current.Year, current.Month);
@@ -70,6 +73,7 @@
         /// </summary>
         /// <param name="current">The current date.</param>
         /// <param name="dayOfWeek">The current day of week.</param>
+        /// <returns>Returns a date representing the final occurence of <paramref name="dayOfWeek"/>.</returns>
         public static DateTime Last(this DateTime current, DayOfWeek dayOfWeek)
         {
             DateTime last = current.LastDayOfMonth();
@@ -87,6 +91,7 @@
         /// </summary>
         /// <param name="current">The current date.</param>
         /// <param name="dayOfWeek">The day of week for the next date to get.</param>
+        /// <returns>Returns a date representing the next occurence of <paramref name="dayOfWeek"/>.</returns>
         public static DateTime Next(this DateTime current, DayOfWeek dayOfWeek)
         {
             var offsetDays = dayOfWeek - current.DayOfWeek;