use markdown in docstring

rcgsheffield · Sep 12, 2023 · 1169f68 · 1169f68
1 parent ed4a82a
commit 1169f68
Showing 1 changed file with 5 additions and 8 deletions.
diff --git a/R/csv_to_binary.R b/R/csv_to_binary.R
@@ -4,14 +4,11 @@ library(cli)
 
 #' Use Duck DB to perform file format conversion.
 #'
-#' DuckDB R API
-#' https://duckdb.org/docs/archive/0.8.1/api/r
-#'
-#' DBI documentation
-#' https://dbi.r-dbi.org/
-#'
-#' Example: "Quickly Convert CSV to Parquet with DuckDB"
-#' https://rmoff.net/2023/03/14/quickly-convert-csv-to-parquet-with-duckdb
+#' See:
+#' 
+#' - [DuckDB R API](https://duckdb.org/docs/archive/0.8.1/api/r)
+#' - [DBI documentation](https://dbi.r-dbi.org/)
+#' - [Example: "Quickly Convert CSV to Parquet with DuckDB"](https://rmoff.net/2023/03/14/quickly-convert-csv-to-parquet-with-duckdb)
 #'
 #' @param raw_data_dir String. Path. The directory that contains the raw data files.
 #' @param output_data_dir String. Path. The directory the output data file(s) should be written to.