add cross-references between knit_patterns and all_patterns in the docs

yihui · Dec 11, 2013 · be5390b · be5390b
1 parent 2796c2e
commit be5390b
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 2 deletions.
diff --git a/R/pattern.R b/R/pattern.R
@@ -3,6 +3,7 @@
 #' This object is a named list of all built-in patterns.
 #' @references Usage: \url{http://yihui.name/knitr/patterns}
 #' @export
+#' @seealso \link{knit_patterns}
 #' @examples all_patterns$rnw; all_patterns$html
 #'
 #' str(all_patterns)
@@ -63,8 +64,10 @@ all_patterns = list(
 #' Patterns are regular expressions and will be used in functions like
 #' \code{\link[base]{grep}} to extract R code and chunk options. The object
 #' \code{knit_patterns} controls the patterns currently used; see the references
-#' and examples for usage.
+#' and examples for usage.  All built-in patterns are available in the list
+#' \link{all_patterns}.
 #'
+#' @seealso \link{all_patterns}
 #' @references Usage: \url{http://yihui.name/knitr/objects}
 #'
 #' Components in \code{knit_patterns}: \url{http://yihui.name/knitr/patterns}

diff --git a/man/all_patterns.Rd b/man/all_patterns.Rd
@@ -68,4 +68,7 @@ str(all_patterns)
 \references{
 Usage: \url{http://yihui.name/knitr/patterns}
 }
+\seealso{
+\link{knit_patterns}
+}
 \keyword{datasets}
diff --git a/man/knit_patterns.Rd b/man/knit_patterns.Rd
@@ -15,7 +15,8 @@ knit_patterns
 Patterns are regular expressions and will be used in functions like
 \code{\link[base]{grep}} to extract R code and chunk options. The object
 \code{knit_patterns} controls the patterns currently used; see the references
-and examples for usage.
+and examples for usage.  All built-in patterns are available in the list
+\link{all_patterns}.
 }
 \examples{
 library(knitr)
@@ -40,4 +41,7 @@ Usage: \url{http://yihui.name/knitr/objects}
 
 Components in \code{knit_patterns}: \url{http://yihui.name/knitr/patterns}
 }
+\seealso{
+\link{all_patterns}
+}
 \keyword{datasets}