minor cleanup

* main now returns the right status
* added comment
* added assumption about multiple occurances on the same line

Author: TomHennen

Concordance.xcodeproj/project.xcworkspace/xcuserdata/Tom.xcuserdatad/UserInterfaceState.xcuserstate

@@ -17,6 +17,7 @@ Assumptions
 * Apart from ', the program removes all punctuation and unprintable characters.
 * That all input files are ASCII (or will be interpreted as ASCII)
 * That lines are limited to 1024 characters in length
+* That words that appear multiple times on the same line will have that line listed multiple times for that word
 
 Files
 -----

README.md

@@ -20,10 +20,10 @@
     size.
  
  where:
-     P is the average length of a line
-     L is the number of lines
-     K is the number of unique words
-     W is the average length of a word
+    P is the average length of a line
+    L is the number of lines
+    K is the number of unique words
+    W is the average length of a word
  */
 int main(int argc, char* argv[])
 {
@@ -55,5 +55,5 @@ int main(int argc, char* argv[])
     // though we could technically just exit and let the OS deal with this
     // it'll free the memory for us
     stateDelete(state);
-    return 0;
+    return result;
 }

src/main.c

@@ -6,6 +6,7 @@
 #include "uthash.h"
 #include "process.h"
 
+// the maximum number of characters we expect to be in a line
 const unsigned int MAX_LINE_LENGTH = 1024;
 // these are the tokens we'll use to split words in a line
 // don't include "'" since it could be a contraction