docs(list_reports): fix messy parameter

Refs #4

R/list_reports.R

 #' List reports with headers
 #'
 #' @param reports_dir [character] path for the reports
-#' @param reports [character] subfolders containing each report. By default,
-#' reports are folders in `reports_dir` that match `pattern`
-#' @param pattern [character] regex pattern for filtering report directories in
-#' `reports_dir` folder (ignored if `reports` is provided)
+#' @param reports [character] subfolders containing each report.
 #' @param index [character] name of the report index file
 #'
 #' @return A [data.frame] containing one row by report found. Each row contain the following columns:

R/render_reports.R

-#' Render reports
+#' Render fairify reports
 #'
-#' @param reports_dir [character] path for the reports
-#' @param reports [character] subfolders containing each report
+#' @inheritParams list_reports
 #' @param publish_dir [character] rendering output path relatively to the report
 #' folder which is in format `"./reports/my_report"`
 #' @param output_format output format, see [bookdown::render_book]. Only

man/list_reports.Rd

@@ -13,13 +13,9 @@ list_reports(
 \arguments{
 \item{reports_dir}{\link{character} path for the reports}
 
-\item{reports}{\link{character} subfolders containing each report. By default,
-reports are folders in \code{reports_dir} that match \code{pattern}}
+\item{reports}{\link{character} subfolders containing each report.}
 
 \item{index}{\link{character} name of the report index file}
-
-\item{pattern}{\link{character} regex pattern for filtering report directories in
-\code{reports_dir} folder (ignored if \code{reports} is provided)}
 }
 \value{
 A \link{data.frame} containing one row by report found. Each row contain the following columns:

man/render_reports.Rd

@@ -3,7 +3,7 @@
 \name{render_report}
 \alias{render_report}
 \alias{render_reports}
-\title{Render reports}
+\title{Render fairify reports}
 \usage{
 render_report(
   input,
@@ -41,7 +41,7 @@ used (possibly not specified, either, in which case a directory name
 
 \item{reports_dir}{\link{character} path for the reports}
 
-\item{reports}{\link{character} subfolders containing each report}
+\item{reports}{\link{character} subfolders containing each report.}
 
 \item{publish_dir}{\link{character} rendering output path relatively to the report
 folder which is in format \code{"./reports/my_report"}}
@@ -50,7 +50,7 @@ folder which is in format \code{"./reports/my_report"}}
 \code{NULL}, this function is used for side effect.
 }
 \description{
-Render reports
+Render fairify reports
 }
 \examples{
 # Create a fairify project in a temporary folder