Update help files to pass HTML5 validation

Author: rich-iannone

R/col_count_match.R

@@ -43,9 +43,9 @@
 #'   against the target table in terms of column count values. If supplying a
 #'   comparison table, it can either be a table object such as a data frame, a
 #'   tibble, a `tbl_dbi` object, or a `tbl_spark` object. Alternatively, a
-#'   table-prep formula (`~ <table reading code>`) or a function (`function()
-#'   <table reading code>`) can be used to lazily read in the comparison table
-#'   at interrogation time.
+#'   table-prep formula (`~ <tbl reading code>`) or a function (
+#'   `function() <tbl reading code>`) can be used to lazily read in the
+#'   comparison table at interrogation time.
 #'   
 #' @return For the validation function, the return value is either a
 #'   `ptblank_agent` object or a table object (depending on whether an agent

R/col_schema_match.R

@@ -519,8 +519,8 @@ test_col_schema_match <- function(
 #'   then any values provided to `...` will be ignored. This can either be a
 #'   table object, a table-prep formula.This can be a table object such as a
 #'   data frame, a tibble, a `tbl_dbi` object, or a `tbl_spark` object.
-#'   Alternatively, a table-prep formula (`~ <table reading code>`) or a
-#'   function (`function() <table reading code>`) can be used to lazily read in
+#'   Alternatively, a table-prep formula (`~ <tbl reading code>`) or a
+#'   function (`function() <tbl reading code>`) can be used to lazily read in
 #'   the table at interrogation time.
 #'   
 #' @param .db_col_types *Use R column types or database column types?*

R/create_agent.R

@@ -44,15 +44,15 @@
 #' 
 #' @param tbl *Table or expression for reading in one*
 #' 
-#'   `obj:<tbl_*>|<table reading expression>` // **required**
+#'   `obj:<tbl_*>|<tbl reading expression>` // **required**
 #' 
 #'   The input table. This can be a data frame, a tibble, a `tbl_dbi` object, or
 #'   a `tbl_spark` object. Alternatively, an expression can be supplied to serve
 #'   as instructions on how to retrieve the target table at interrogation-time.
 #'   There are two ways to specify an association to a target table: (1) as a
 #'   table-prep formula, which is a right-hand side (RHS) formula expression
-#'   (e.g., `~ { <table reading code>}`), or (2) as a function (e.g.,
-#'   `function() { <table reading code>}`).
+#'   (e.g., `~ { <tbl reading code>}`), or (2) as a function (e.g.,
+#'   `function() { <tbl reading code>}`).
 #'   
 #' @param tbl_name *A table name*
 #' 

R/create_informant.R

@@ -55,15 +55,15 @@
 #' 
 #' @param tbl *Table or expression for reading in one*
 #' 
-#'   `obj:<tbl_*>|<table reading expression>` // **required**
+#'   `obj:<tbl_*>|<tbl reading expression>` // **required**
 #' 
 #'   The input table. This can be a data frame, a tibble, a `tbl_dbi` object, or
 #'   a `tbl_spark` object. Alternatively, an expression can be supplied to serve
 #'   as instructions on how to retrieve the target table at incorporation-time.
 #'   There are two ways to specify an association to a target table: (1) as a
 #'   table-prep formula, which is a right-hand side (RHS) formula expression
-#'   (e.g., `~ { <table reading code>}`), or (2) as a function (e.g.,
-#'   `function() { <table reading code>}`).
+#'   (e.g., `~ { <tbl reading code>}`), or (2) as a function (e.g.,
+#'   `function() { <tbl reading code>}`).
 #'   
 #' @param agent *The pointblank agent object*
 #' 

R/incorporate.R

@@ -207,7 +207,7 @@ incorporate <- function(informant) {
       # TODO: Improve the `stop()` message here
       stop(
         "The `read_fn` object must be a function or an R formula.\n",
-        "* A function can be made with `function()` {<table reading code>}.\n",
+        "* A function can be made with `function()` {<tbl reading code>}.\n",
         "* An R formula can also be used, with the expression on the RHS.",
         call. = FALSE
       )

R/info_add.R

@@ -246,7 +246,7 @@ info_tabular <- function(
 #' 
 #' @param columns *The target columns*
 #'   
-#'   `vector<character>|vars(<columns>)`` // **required**
+#'   `vector<character>|vars(<columns>)` // **required**
 #' 
 #'   The column or set of columns to focus on. Can be defined as a column name
 #'   in quotes (e.g., `"<column_name>"`), one or more column names in `vars()`
@@ -723,7 +723,7 @@ check_info_columns_tbl <- function(tbl) {
 #'   
 #' @param section_name *The section name*
 #' 
-#'   `scalar<character>`` // **required**
+#'   `scalar<character>` // **required**
 #' 
 #'   The name of the section for which this information pertains.
 #'   
@@ -965,7 +965,7 @@ info_section <- function(
 #' 
 #' @param snippet_name *The snippet name*
 #' 
-#'   `scalar<character>`` // **required**
+#'   `scalar<character>` // **required**
 #' 
 #'   The name for snippet, which is used for interpolating the result of the
 #'   snippet formula into *info text* defined by an `info_*()` function.
@@ -1162,7 +1162,7 @@ info_snippet <- function(
 #' 
 #' @param column *The target column*
 #'   
-#'   `scalar<character>`` // **required**
+#'   `scalar<character>` // **required**
 #' 
 #'   The name of the column that contains the target values.
 #' 
@@ -1465,7 +1465,7 @@ snip_list <- function(
 #'
 #' @param column *The target column*
 #'   
-#'   `scalar<character>`` // **required**
+#'   `scalar<character>` // **required**
 #' 
 #'   The name of the column that contains the target values.
 #' 
@@ -1552,7 +1552,7 @@ snip_stats <- function(
 #' 
 #' @param column *The target column*
 #'   
-#'   `scalar<character>`` // **required**
+#'   `scalar<character>` // **required**
 #' 
 #'   The name of the column that contains the target values.
 #'   
@@ -1626,7 +1626,7 @@ snip_lowest <- function(column) {
 #' 
 #' @param column *The target column*
 #'   
-#'   `scalar<character>`` // **required**
+#'   `scalar<character>` // **required**
 #' 
 #'   The name of the column that contains the target values.
 #'   

R/interrogate.R

@@ -192,7 +192,7 @@ interrogate <- function(
       # TODO: create a better `stop()` message
       stop(
         "The `read_fn` object must be a function or an R formula.\n",
-        "* A function can be made with `function()` {<table reading code>}.\n",
+        "* A function can be made with `function()` {<tbl reading code>}.\n",
         "* An R formula can also be used, with the expression on the RHS.",
         call. = FALSE
       )

R/object_ops.R

@@ -844,16 +844,16 @@ export_report <- function(
 #'   
 #' @param tbl *Table or expression for reading in one*
 #' 
-#'   `obj:<tbl_*>|<table reading expression>` // **required**
+#'   `obj:<tbl_*>|<tbl reading expression>` // **required**
 #' 
 #'   The input table for the *agent* or the *informant*. This can be a data
 #'   frame, a tibble, a `tbl_dbi` object, or a `tbl_spark` object.
 #'   Alternatively, an expression can be supplied to serve as instructions on
 #'   how to retrieve the target table at interrogation- or incorporation-time.
 #'   There are two ways to specify an association to a target table: (1) as a
 #'   table-prep formula, which is a right-hand side (RHS) formula expression
-#'   (e.g., `~ { <table reading code>}`), or (2) as a function (e.g.,
-#'   `function() { <table reading code>}`).
+#'   (e.g., `~ { <tbl reading code>}`), or (2) as a function (e.g.,
+#'   `function() { <tbl reading code>}`).
 #'   
 #' @param tbl_name *A table name*
 #' 

R/row_count_match.R

@@ -43,9 +43,9 @@
 #'   against the target table in terms of row count values. If supplying a
 #'   comparison table, it can either be a table object such as a data frame, a
 #'   tibble, a `tbl_dbi` object, or a `tbl_spark` object. Alternatively, a
-#'   table-prep formula (`~ <table reading code>`) or a function (`function()
-#'   <table reading code>`) can be used to lazily read in the comparison table
-#'   at interrogation time.
+#'   table-prep formula (`~ <tbl reading code>`) or a function
+#'   (`function() <tbl reading code>`) can be used to lazily read in the
+#'   comparison table at interrogation time.
 #'   
 #' @param tbl_compare *[Deprecated] Comparison table*
 #' 

R/tbl_match.R

@@ -43,8 +43,8 @@
 #'   A table to compare against the target table. This can either be a table
 #'   object, a table-prep formula. This can be a table object such as a data
 #'   frame, a tibble, a `tbl_dbi` object, or a `tbl_spark` object.
-#'   Alternatively, a table-prep formula (`~ <table reading code>`) or a
-#'   function (`function() <table reading code>`) can be used to lazily read in
+#'   Alternatively, a table-prep formula (`~ <tbl reading code>`) or a
+#'   function (`function() <tbl reading code>`) can be used to lazily read in
 #'   the table at interrogation time.
 #'   
 #' @return For the validation function, the return value is either a