From 066efa67f6892954ba6efef3e103116055bb0ef8 Mon Sep 17 00:00:00 2001
From: "OPTIMUS-PRIME\\craig" <craig@craigoates.net>
Date: Sun, 29 Jul 2018 01:17:00 +0100
Subject: [PATCH] Updated the XML comments for CleanResultAsync.

---
 WetPancake/ProductServices.fs | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/WetPancake/ProductServices.fs b/WetPancake/ProductServices.fs
index a0d464c..5bba548 100644
--- a/WetPancake/ProductServices.fs
+++ b/WetPancake/ProductServices.fs
@@ -18,14 +18,21 @@ module  Pancake =
     /// </summary>
     /// <param name="noOfSentences">
     /// The number of sentences the cleaned string should have.
+    /// This should be smaller than the number of sentences the original text has.
     /// </param>
     /// <param name="text">
     /// The string to clean.
     /// </param>
+    /// <returns>
+    /// A string of text which has been trimmed to the specified sentence count.
+    /// </returns>
+    /// <exception cref="System.InvalidOperationException">
+    /// Thrown when the number of sentences requested is bigger than the number in the text passed in.
+    /// </exception>
     /// <remarks>
     /// This function's aim is to trim or remove excess sentences.
     /// If the string has less sentences than the number requested, it will not change.
-    /// </remarks> 
+    /// </remarks>
     let CleanResultAsync noOfSentences text =
         async {
             try