adjusted documentation to have more explicit and intentional use f la…

…nguage

DESCRIPTION

@@ -18,9 +18,9 @@ Description: An R framework for constructing human readable regular
     The tools allow the user to (1) write in smaller, modular, named, regular
     expression chunks, (2) write top to bottom, rather than a single string (3)
     comment individual chunks, (4) indent expressions to represent regular
-    expression groups, (5) Add vertical line spaces and R comments (i.e., #),
+    expression groups, (5) add vertical line spaces and R comments (i.e., #),
     and (6) test the validity of the concatenated expression and the modular
-    chunks.
+    regular expression chunks.
 License: GPL-2
 URL: http://trinker.github.com/regexr/
 BugReports: http://github.com/trinker/regexr/issues

R/regexr-package.R

@@ -3,12 +3,15 @@
 #' \pkg{regexr} is an R framework for constructing human readable regular 
 #' expressions.  It aims to provide tools that enable the user to write regular 
 #' expressions in a way that is similar to the ways R code is written.  
-#' The tools allow the user to (1) write in smaller, modular, named, regular 
-#' expression chunks, (2) write top to bottom, rather than a single string (3) 
-#' comment individual chunks, (4) indent expressions to represent regular 
-#' expression groups, (5) test the validity of the concatenated expression 
-#' and the modular chunks, and (6) test the validity of the concatenated 
-#' expression and the modular chunks.. \cr \cr
+#' The tools allow the user to:
+#' \enumerate{
+#'   \item Write in smaller, modular, named, \emph{regular expression chunks}
+#'   \item Write top to bottom, rather than a single string
+#'   \item Comment individual \emph{regular expression chunks}
+#'   \item Indent expressions to represent regular expression groups
+#'   \item Add vertical line spaces and R comments (i.e., \code{#})
+#'   \item Test the validity of the \emph{concatenated expression} and the modular regular expression chunks
+#' } 
 #' This framework harnesses the power and flexibility of regular expressions 
 #' but provides a structural frame that is more consistent with both code 
 #' writing and natural language conventions.  

README.Rmd

@@ -17,7 +17,7 @@
 3. Comment individual chunks    
 4. Indent expressions to represent regular expression groups
 5. Add vertical line spaces and R comments (i.e., #)
-6. Test the validity of the *concatenated expression* and the modular chunks     
+6. Test the validity of the *concatenated expression* and the modular *regular expression chunks*      
 
 This framework harnesses the power and flexibility of regular expressions but provides a structural frame that is more consistent with both code writing and natural language conventions.  The user decides how to break, indent, name, and comment the regular expressions in a way that is human readable, meaningful, and modular.
 
@@ -39,6 +39,13 @@ devtools::install_github("trinker/regexr")
 - [Web Page](http://trinker.github.com/regexr/)     
 - [Package PDF Help Manual](https://dl.dropboxusercontent.com/u/61803503/regexr.pdf)   
 
+## Contact
+
+You are welcome to:
+* submit suggestions and bug-reports at: <https://github.com/trinker/regexr/issues>
+* send a pull request on: <https://github.com/trinker/regexr/>
+* compose a friendly e-mail to: <tyler.rinker@gmail.com>
+
 ## Functions
 
 ```{r, echo=FALSE, results='asis', warning=FALSE}
@@ -155,9 +162,4 @@ out <- construct(
 )
 ```
 
-## Contact
 
-You are welcome to:
-* submit suggestions and bug-reports at: <https://github.com/trinker/regexr/issues>
-* send a pull request on: <https://github.com/trinker/regexr/>
-* compose a friendly e-mail to: <tyler.rinker@gmail.com>

man/regexr.Rd

@@ -9,12 +9,15 @@
 \pkg{regexr} is an R framework for constructing human readable regular
 expressions.  It aims to provide tools that enable the user to write regular
 expressions in a way that is similar to the ways R code is written.
-The tools allow the user to (1) write in smaller, modular, named, regular
-expression chunks, (2) write top to bottom, rather than a single string (3)
-comment individual chunks, (4) indent expressions to represent regular
-expression groups, (5) test the validity of the concatenated expression
-and the modular chunks, and (6) test the validity of the concatenated
-expression and the modular chunks.. \cr \cr
+The tools allow the user to:
+\enumerate{
+  \item Write in smaller, modular, named, \emph{regular expression chunks}
+  \item Write top to bottom, rather than a single string
+  \item Comment individual \emph{regular expression chunks}
+  \item Indent expressions to represent regular expression groups
+  \item Add vertical line spaces and R comments (i.e., \code{#})
+  \item Test the validity of the \emph{concatenated expression} and the modular regular expression chunks
+}
 This framework harnesses the power and flexibility of regular expressions
 but provides a structural frame that is more consistent with both code
 writing and natural language conventions.