Browse Source

Stubbed out XML comments for "clean" functions.

master
Craig Oates 6 years ago
parent
commit
848373ded2
  1. 2
      WetPancake/DataServices.fs
  2. 21
      WetPancake/ProductServices.fs

2
WetPancake/DataServices.fs

@ -87,7 +87,7 @@
SplitText splits the text and adds a space at the split.
This leads to the text having double-spaces when concatenated back together.
*)
let RemoveArtifactSentences noOfSentences text =
let RemoveArtefactSentences noOfSentences text =
text
|> SplitText @"(?<=[\.\!\?]\s)"
|> Array.take noOfSentences

21
WetPancake/ProductServices.fs

@ -18,12 +18,16 @@ module Pancake =
[] XML COMMENTS IN THIS FILE
=============================================================================================================== *)
// TODO: Add XML comments to CleanResult function.
/// <summary>
///
/// </summary>
/// <param name="noOfSentences"></param>
/// <param name="text"></param>
let CleanResultAsync noOfSentences text =
async {
let cleanText =
text
|> RemoveArtifactSentences noOfSentences
|> RemoveArtefactSentences noOfSentences
return cleanText
}
@ -159,7 +163,11 @@ module Pancake =
return files
}
// TODO: Add XML comment for RequestCleanTextAsync.
/// <summary>
///
/// </summary>
/// <param name="gibberishLevel"></param>
/// <param name="sentences"></param>
let RequestCleanTextAsync (gibberishLevel: int) (sentences: int) =
async {
let! text = RequestTextAsync gibberishLevel sentences
@ -167,7 +175,12 @@ module Pancake =
return cleanText
}
// TODO: Add XML comment for RequestCleanTextFromFileAsync.
/// <summary>
///
/// </summary>
/// <param name="gibberishLevel"></param>
/// <param name="sentences"></param>
/// <param name="filePath"></param>
let RequestCleanTextFromFileAsync (gibberishLevel: int) (sentences: int) (filePath: string) =
async {
let! text = RequestTextFromFileAsync gibberishLevel sentences filePath

Loading…
Cancel
Save