Doc clean up

README.md

@@ -8,7 +8,7 @@ string manipulation libraries of Java Apache Commons. GoUtils includes the follo
 * StringUtils (partial implementation)
 
 ## Installation
-If you have Go set up on your system, enter this within the command line/terminal:
+If you have Go set up on your system, from the GOPATH directory within the command line/terminal, enter this:
 
 	go get github.com/aokoli/goutils
 

randomstringutils.go

@@ -38,7 +38,7 @@ Parameter:
 
 Returns:
 	string - the random string
-	error - an error stemming from an invalid parameter within underlying function
+	error - an error stemming from an invalid parameter within underlying function, RandomSeed(...)
 */
 func RandomNonAlphaNumeric (count int) (string, error) {
     return RandomAlphaNumericCustom(count, false, false)
@@ -54,7 +54,7 @@ Parameter:
 
 Returns:
 	string - the random string
-	error - an error stemming from an invalid parameter within underlying function
+	error - an error stemming from an invalid parameter within underlying function, RandomSeed(...)
 */
 func RandomAscii(count int) (string, error) {
     return Random(count, 32, 127, false, false)
@@ -70,7 +70,7 @@ Parameter:
 
 Returns:
 	string - the random string
-	error - an error stemming from an invalid parameter within underlying function
+	error - an error stemming from an invalid parameter within underlying function, RandomSeed(...)
 */
 func RandomNumeric (count int) (string, error) {
     return Random(count, 0, 0, false, true)
@@ -88,7 +88,7 @@ Parameters:
 
 Returns:
 	string - the random string
-	error - an error stemming from an invalid parameter within underlying function
+	error - an error stemming from an invalid parameter within underlying function, RandomSeed(...)
 */
 func RandomAlphabetic (count int) (string, error) {
     return Random(count, 0, 0, true, false)
@@ -104,7 +104,7 @@ Parameter:
 
 Returns:
 	string - the random string
-	error - an error stemming from an invalid parameter within underlying function
+	error - an error stemming from an invalid parameter within underlying function, RandomSeed(...)
 */
 func RandomAlphaNumeric (count int) (string, error) {
     return Random(count, 0, 0, true, true)
@@ -121,7 +121,7 @@ Parameters:
 
 Returns:
 	string - the random string
-	error - an error stemming from an invalid parameter within underlying function 
+	error - an error stemming from an invalid parameter within underlying function, RandomSeed(...) 
 */
 func RandomAlphaNumericCustom (count int, letters bool, numbers bool) (string, error) {
     return Random(count, 0, 0, letters, numbers)
@@ -143,7 +143,7 @@ Parameters:
 
 Returns:
 	string - the random string
-	error - an error stemming from invalid parameters: if count < 0; or the provided chars array is empty; or end <= start; or end > len(chars) 
+	error - an error stemming from an invalid parameter within underlying function, RandomSeed(...) 
 */
 func Random (count int, start int, end int, letters bool, numbers bool, chars ...rune) (string, error) {
 	return RandomSeed (count, start, end, letters, numbers, chars, RANDOM)
@@ -154,7 +154,7 @@ func Random (count int, start int, end int, letters bool, numbers bool, chars ..
 RandomSeed creates a random string based on a variety of options, using supplied source of randomness.
 If the parameters start and end are both 0, start and end are set to ' ' and 'z', the ASCII printable characters, will be used, 
 unless letters and numbers are both false, in which case, start and end are set to 0 and math.MaxInt32, respectively. 
-If chars is not nil, characters between start and end are chosen.
+If chars is not nil, characters stored in chars that are between start and end are chosen.
 This method accepts a user-supplied *rand.Rand instance to use as a source of randomness. By seeding a single *rand.Rand instance
 with a fixed seed and using it for each call, the same random sequence of strings can be generated repeatedly and predictably.
 

randomstringutils_test.go

@@ -1,3 +1,13 @@
+
+
+
+
+
+
+
+
+
+
 package goutils
 
 import (

stringutils.go

@@ -29,9 +29,9 @@ const INDEX_NOT_FOUND = -1
 
 
 /*
-Abbreviate abbreviates a string using ellipses. This will turn "Now is the time for all good men" into "Now is the time for..."
+Abbreviate abbreviates a string using ellipses. This will turn  the string "Now is the time for all good men" into "Now is the time for..."
 
-Specifically: 
+Specifically, the algorithm is as follows: 
 
     - If str is less than maxWidth characters long, return it. 
     - Else abbreviate it to (str[0:maxWidth - 3] + "..."). 
@@ -43,29 +43,28 @@ Parameters:
     maxWidth - maximum length of result string, must be at least 4
 
 Returns:
-    string - abbreviated String
+    string - abbreviated string
     error - if the width is too small
-
 */
 func Abbreviate (str string, maxWidth int) (string, error) {
 	return AbbreviateFull(str, 0, maxWidth)
 }
 
 
 /*
-AbbreviateFull abbreviates a string using ellipses. This will turn "Now is the time for all good men" into "...is the time for..."
+AbbreviateFull abbreviates a string using ellipses. This will turn the string "Now is the time for all good men" into "...is the time for..."
 This function works like Abbreviate(string, int), but allows you to specify a "left edge" offset. Note that this left edge is not 
 necessarily going to be the leftmost character in the result, or the first character following the ellipses, but it will appear 
 somewhere in the result.
-In no case will it return a String of length greater than maxWidth.
+In no case will it return a string of length greater than maxWidth.
 
 Parameters:
-    str - the String to check
+    str - the string to check
     offset - left edge of source string
     maxWidth - maximum length of result string, must be at least 4
 
 Returns:
-    string - abbreviated String
+    string - abbreviated string
     error - if the width is too small
 */
 func AbbreviateFull (str string, offset int, maxWidth int) (string, error) {
@@ -106,7 +105,7 @@ DeleteWhiteSpace deletes all whitespaces from a string as defined by unicode.IsS
 It returns the string without whitespaces.
 
 Parameter:
-    str - the String to delete whitespace from, may be null
+    str - the string to delete whitespace from, may be nil
 
 Returns:
     the string without whitespaces

wordutils.go

@@ -53,6 +53,8 @@ import (
 	"unicode" 
 )
 
+// VERSION indicates the current version of goutils
+const VERSION = "1.0.0"
 
 /*
 Wrap wraps a single line of text, identifying words by ' '.
@@ -227,7 +229,7 @@ func CapitalizeFully (str string, delimiters ...rune) string {
 /*
 Uncapitalize uncapitalizes all the whitespace separated words in a string. Only the first letter of each word is changed.
 The delimiters represent a set of characters understood to separate words. The first string character and the first non-delimiter 
-character after a delimiter will be uncapitalized. Whitespace is defined by unicode.IsSpacea(char). 
+character after a delimiter will be uncapitalized. Whitespace is defined by unicode.IsSpace(char). 
 
 Parameters:
     str - the string to uncapitalize fully