Skip to content

Commit

Permalink
Cross-link documentation (#203)
Browse files Browse the repository at this point in the history
  • Loading branch information
salim-b authored Oct 13, 2020
1 parent 3172375 commit bcb719b
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion R/color.R
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
#' color terminal output. `glue_col()` and `glue_data_col()` functions provide
#' additional syntax to make using these functions in glue strings easier.
#'
#' Using the following syntax will apply the function `crayon::blue()` to the text 'foo bar'.
#' Using the following syntax will apply the function [crayon::blue()] to the text 'foo bar'.
#'
#' ```
#' {blue foo bar}
Expand Down
2 changes: 1 addition & 1 deletion R/glue.R
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
#' with. If `NULL` missing values are propagated, that is an `NA` result will
#' cause `NA` output. Otherwise the value is replaced by the value of `.na`.
#' @param .trim \[`logical(1)`: \sQuote{TRUE}]\cr Whether to trim the input
#' template with `trim()` or not.
#' template with [trim()] or not.
#' @seealso <https://www.python.org/dev/peps/pep-0498/> and
#' <https://www.python.org/dev/peps/pep-0257/> upon which this is based.
#' @examples
Expand Down
2 changes: 1 addition & 1 deletion R/quoting.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#' Quoting operators
#'
#' These functions make it easy to quote each individual element and are useful
#' in conjunction with `glue_collapse()`.
#' in conjunction with [glue_collapse()].
#' @param x A character to quote.
#' @name quoting
#' @export
Expand Down
2 changes: 1 addition & 1 deletion R/safe.R
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#' Safely interpolate strings
#'
#' `glue_safe()` and `glue_data_safe()` differ from `glue()` and `glue_data()`
#' `glue_safe()` and `glue_data_safe()` differ from [glue()] and [glue_data()]
#' in that the safe versions only look up symbols from an environment use
#' [get()] they do not execute any R code. This makes them suitable when used
#' with untrusted input, such as inputs in a shiny application, where using the
Expand Down
8 changes: 4 additions & 4 deletions R/sql.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#'
#' SQL databases often have custom quotation syntax for identifiers and strings
#' which make writing SQL queries error prone and cumbersome to do. `glue_sql()` and
#' `glue_data_sql()` are analogs to `glue()` and `glue_data()` which handle the
#' `glue_data_sql()` are analogs to [glue()] and [glue_data()] which handle the
#' SQL quoting.
#'
#' They automatically quote character results, quote identifiers if the glue
Expand All @@ -11,7 +11,7 @@
#' column (which should be quoted) pass the data to `glue_sql()` as a
#' character.
#'
#' Returning the result with `DBI::SQL()` will suppress quoting if desired for
#' Returning the result with [DBI::SQL()] will suppress quoting if desired for
#' a given value.
#'
#' Note [parameterized queries](https://db.rstudio.com/best-practices/run-queries-safely#parameterized-queries)
Expand All @@ -22,8 +22,8 @@
#' collapsed with commas. This is useful for the [SQL IN Operator](https://www.w3schools.com/sql/sql_in.asp)
#' for instance.
#' @inheritParams glue
#' @param .con \[`DBIConnection`]:A DBI connection object obtained from `DBI::dbConnect()`.
#' @return A `DBI::SQL()` object with the given query.
#' @param .con \[`DBIConnection`]:A DBI connection object obtained from [DBI::dbConnect()].
#' @return A [DBI::SQL()] object with the given query.
#' @examples
#' con <- DBI::dbConnect(RSQLite::SQLite(), ":memory:")
#' iris2 <- iris
Expand Down

0 comments on commit bcb719b

Please sign in to comment.