minor changes

Author: salim-b

R/tocr.gen.R

@@ -557,8 +557,7 @@ process_md <- function(md_lines,
 #'   fallback the backlinks point to the next header line above `position` (if any found). This will also be the case if `md_flavor = "gitlab"` and
 #'   `title_tier` is set to a non-header value (`"regular"`, `"bold"` or `"italic"`) because GitLab currently ignores manually set HTML `<id>` attributes.
 #' @param backlink_strings String(s) to use as link text back to the TOC. A character vector of length 1 or 2. If two strings are provided, the first one will
-#'   be used for backlinks below `position`, the second one for backlinks above `position`. Note that at least Unicode 7.0 support is required for the default
-#'   symbols `\U1F805` and `\U1F807` to be correctly displayed.
+#'   be used for backlinks below `position`, the second one for backlinks above `position`.
 #' @param backlink_position Position of the backlinks. Possible values include:
 #'   - `"before"`: Before the actual header text.
 #'   - `"after"`: After the actual header text.

README.md

@@ -73,7 +73,7 @@ This package borrows a lot of the [Tidyverse](https://www.tidyverse.org/) design
 
 -   Usage of [R’s right-hand assignment operator `->`](https://rdrr.io/r/base/assignOps.html) is not allowed[^3].
 
--   R source code is *not* split over several files as [suggested by the TSG](https://style.tidyverse.org/package-files.html) but instead is (as far as possible) kept in the single file [`Rmd/tocr.Rmd`](Rmd/tocr.Rmd) which is well-structured thanks to its [Markdown support](#r-markdown-format).
+-   R source code is *not* split over several files as [suggested by the TSG](https://style.tidyverse.org/package-files.html) but instead is (as far as possible) kept in the single file [`Rmd/tocr.Rmd`](https://gitlab.com/rpkg.dev/tocr/-/tree/master/Rmd/tocr.Rmd) which is well-structured thanks to its [Markdown support](#r-markdown-format).
 
 As far as possible, these deviations from the TSG plus some additional restrictions are formally specified in the [lintr configuration file](https://github.com/jimhester/lintr#project-configuration) [`.lintr`](.lintr), so lintr can be used right away to check for formatting issues:
 

Rmd/tocr.Rmd

@@ -557,23 +557,23 @@ process_md <- function(md_lines,
 
 ## DEBUGGING
 
-### Initialize all parameters of function `add_toc()` with default/dummy params
+### Dummy run
 
 ```{r, purl = FALSE}
-md <- "https://raw.githubusercontent.com/rstudio/rmarkdown/master/README.md"
-min_tier <- 2L
-max_tier <- 6L
-position <- "above"
-md_flavor <- "github"
-add_title <- TRUE
-title <- "Table of contents"
-title_tier <- min_tier
-add_backlinks <- add_title
-backlink_strings <- c("\U1F805", "\U1F807")
-backlink_position <- "before"
-listing_style <- "-"
-toc_id <- "toc"
-old_toc_id <- toc_id
+tocr::add_toc(md = "https://raw.githubusercontent.com/rstudio/rmarkdown/master/README.md",
+              min_tier = 2L,
+              max_tier = 6L,
+              position = "above",
+              md_flavor = "github",
+              add_title = TRUE,
+              title = "Table of contents",
+              title_tier = min_tier,
+              add_backlinks = add_title,
+              backlink_strings = c("\u2191", "\u2193"),
+              backlink_position = "before",
+              listing_style = "-",
+              toc_id = "toc",
+              old_toc_id = toc_id)
 ```
 
 # EXPORTED
@@ -622,8 +622,7 @@ old_toc_id <- toc_id
 #'   fallback the backlinks point to the next header line above `position` (if any found). This will also be the case if `md_flavor = "gitlab"` and
 #'   `title_tier` is set to a non-header value (`"regular"`, `"bold"` or `"italic"`) because GitLab currently ignores manually set HTML `<id>` attributes.
 #' @param backlink_strings String(s) to use as link text back to the TOC. A character vector of length 1 or 2. If two strings are provided, the first one will
-#'   be used for backlinks below `position`, the second one for backlinks above `position`. Note that at least Unicode 7.0 support is required for the default
-#'   symbols `\U1F805` and `\U1F807` to be correctly displayed.
+#'   be used for backlinks below `position`, the second one for backlinks above `position`.
 #' @param backlink_position Position of the backlinks. Possible values include:
 #'   - `"before"`: Before the actual header text.
 #'   - `"after"`: After the actual header text.

man/add_toc.Rd

@@ -71,7 +71,7 @@ This package borrows a lot of the [Tidyverse](https://www.tidyverse.org/) design
 
 -   Usage of [R's right-hand assignment operator `->`](https://rdrr.io/r/base/assignOps.html) is not allowed[^3].
 
--   R source code is *not* split over several files as [suggested by the TSG](https://style.tidyverse.org/package-files.html) but instead is (as far as possible) kept in the single file [`Rmd/tocr.Rmd`](Rmd/tocr.Rmd) which is well-structured thanks to its [Markdown support](#r-markdown-format).
+-   R source code is *not* split over several files as [suggested by the TSG](https://style.tidyverse.org/package-files.html) but instead is (as far as possible) kept in the single file [`Rmd/tocr.Rmd`](https://gitlab.com/rpkg.dev/tocr/-/tree/master/Rmd/tocr.Rmd) which is well-structured thanks to its [Markdown support](#r-markdown-format).
 
 As far as possible, these deviations from the TSG plus some additional restrictions are formally specified in the [lintr configuration file](https://github.com/jimhester/lintr#project-configuration) [`.lintr`](.lintr), so lintr can be used right away to check for formatting issues: