Strip trailing whitespace throughout R/ + tests/testthat (#2566)

* Remove trailing WS. * Use usethis syntax (+ separate pkgdown.R and pkgdown-package.R in 2 files) * Delete outdated file * Test lint! (expect_match + expect_null)
r-lib · May 21, 2024 · 39ea964 · 39ea964
1 parent 107694d
commit 39ea964
Show file tree

Hide file tree

Showing 37 changed files with 215 additions and 322 deletions.
diff --git a/R/build-articles.R b/R/build-articles.R
@@ -88,9 +88,9 @@
 #'
 #' ## Missing topics
 #'
-#' pkgdown will warn if there are (non-internal) articles that aren't listed 
-#' in the articles index. You can suppress such warnings by listing the 
-#' affected articles in a section with `title: internal` (case sensitive); 
+#' pkgdown will warn if there are (non-internal) articles that aren't listed
+#' in the articles index. You can suppress such warnings by listing the
+#' affected articles in a section with `title: internal` (case sensitive);
 #' this section will not be displayed on the index page.
 #'
 #' # External files

diff --git a/R/build-home-authors.R b/R/build-home-authors.R
@@ -292,7 +292,7 @@ citation_auto <- function(pkg) {
   )
 }
 
-# helpers -----------------------------------------------------------------
+# helpers -------------------------------------------------------------------------
 
 # Not strictly necessary, but produces a simpler data structure testing
 remove_orcid <- function(x) {
@@ -301,4 +301,4 @@ remove_orcid <- function(x) {
     names(out) <- NULL
   }
   out
-}
+}
diff --git a/R/build-home.R b/R/build-home.R
@@ -15,68 +15,68 @@
 #' iterating when experimenting with site styles.
 #'
 #' # Home page
-#' 
+#'
 #' The main content of the home page (`index.html`) is generated from
 #' `pkgdown/index.md`, `index.md`, or `README.md`, in that order.
-#' Most packages will use `README.md` because that's also displayed by GitHub 
-#' and CRAN. Use `index.md` if you want your package website to look 
-#' different to your README, and use `pkgdown/index.md` if you don't want that 
+#' Most packages will use `README.md` because that's also displayed by GitHub
+#' and CRAN. Use `index.md` if you want your package website to look
+#' different to your README, and use `pkgdown/index.md` if you don't want that
 #' file to live in your package root directory.
-#' 
-#' If you use `index.Rmd` or `README.Rmd` it's your responsibility to knit 
-#' the document to create the corresponding `.md`. pkgdown does not do this 
+#'
+#' If you use `index.Rmd` or `README.Rmd` it's your responsibility to knit
+#' the document to create the corresponding `.md`. pkgdown does not do this
 #' for you because it only touches files in the `doc/` directory.
-#' 
-#' Extra markdown files in the base directory (e.g. `ROADMAP.md`) or in 
+#'
+#' Extra markdown files in the base directory (e.g. `ROADMAP.md`) or in
 #' `.github/` (e.g. `CODE_OF_CONDUCT.md`) are copied by `build_home()` to `docs/` and converted to HTML.
-#' 
-#' The home page also features a sidebar with information extracted from the 
-#' package. You can tweak it via the configuration file, to help make the home 
+#'
+#' The home page also features a sidebar with information extracted from the
+#' package. You can tweak it via the configuration file, to help make the home
 #' page an as informative as possible landing page.
-#' 
+#'
 #' ## Images and figures
-#' 
-#' If you want to include images in your `README.md`, they must be stored 
+#'
+#' If you want to include images in your `README.md`, they must be stored
 #' somewhere in the package so that they can be displayed on the CRAN website.
-#' The best place to put them is `man/figures`. If you are generating figures 
+#' The best place to put them is `man/figures`. If you are generating figures
 #' with R Markdown, make sure you set up `fig.path` as followed:
-#' 
+#'
 #' ``` r
 #' knitr::opts_chunk$set(
 #'   fig.path = "man/figures/"
 #' )
 #' ```
-#' 
+#'
 #' This should usually go in a chunk with `include = FALSE`.
-#' 
+#'
 #' ```` markdown
 #' ```{r chunk-name, include=FALSE}`r ''`
 #' knitr::opts_chunk$set(
 #'   fig.path = "man/figures/"
 #' )
 #' ```
 #' ````
-#' 
+#'
 #' ## Package logo
-#' 
+#'
 #' If you have a package logo, you can include it at the top of your README
 #' in a level-one heading:
-#' 
+#'
 #' ``` markdown
 #' # pkgdown <img src="man/figures/logo.png" align="right" />
 #' ```
-#' 
+#'
 #' [init_site()] will also automatically create a favicon set from your package logo.
-#' 
+#'
 #' ## YAML config - title and description
-#' 
+#'
 #' By default, the page title and description are extracted automatically from
 #' the `Title` and `Description` fields `DESCRIPTION` (stripping single quotes
-#' off quoted words). CRAN ensures that these fields don't contain phrases 
-#' like "R package" because that's obvious on CRAN. To make your package more 
-#' findable on search engines, it's good practice to override the `title` and 
+#' off quoted words). CRAN ensures that these fields don't contain phrases
+#' like "R package" because that's obvious on CRAN. To make your package more
+#' findable on search engines, it's good practice to override the `title` and
 #' `description`, thinking about what people might search for:
-#' 
+#'
 #' ```yaml
 #' home:
 #'   title: An R package for pool-noodle discovery
@@ -85,45 +85,45 @@
 #'     using this package to automatically discover and add pool-noodles
 #'     to your growing collection.
 #' ```
-#' 
-#' (Note the use of YAML's `>` i.e. "YAML pipes"; this is a convenient way of 
+#'
+#' (Note the use of YAML's `>` i.e. "YAML pipes"; this is a convenient way of
 #' writing paragraphs of text.)
-#' 
+#'
 #' ## Dev badges
-#' 
+#'
 #' pkgdown identifies badges in three ways:
-#' 
-#' -   Any image-containing links between `<!-- badges: start -->` and 
-#'     `<!-- badges: end -->`, as e.g. created by `usethis::use_readme_md()` 
-#'     or `usethis::use_readme_rmd()`. There should always be an empty line after 
-#'     the `<!-- badges: end -->` line. If you divide badges into paragraphs, 
+#'
+#' -   Any image-containing links between `<!-- badges: start -->` and
+#'     `<!-- badges: end -->`, as e.g. created by `usethis::use_readme_md()`
+#'     or `usethis::use_readme_rmd()`. There should always be an empty line after
+#'     the `<!-- badges: end -->` line. If you divide badges into paragraphs,
 #'     make sure to add an empty line before the `<!-- badges: end -->` line.
-#' 
+#'
 #' -   Any image-containing links within `<div id="badges"></div>`.
-#' 
+#'
 #' -   Within the first paragraph, if it only contains image-containing links.
-#' 
+#'
 #' Identified badges are **removed** from the _main content_.
 #' They are shown or not in the _sidebar_ depending on the development mode and
 #' sidebar customization, see the sidebar section.
-#' 
+#'
 #' # Authors
-#' 
+#'
 #' By default, pkgdown will display author information in three places:
-#' 
+#'
 #' * the sidebar,
 #' * the left part side of the footer,
 #' * the author page.
-#' 
-#' This documentation describes how to customise the overall author display. 
-#' See `?build_home` and `?build_site` for details about changing the location 
+#'
+#' This documentation describes how to customise the overall author display.
+#' See `?build_home` and `?build_site` for details about changing the location
 #' of the authors information within the home sidebar and the site footer.
-#' 
+#'
 #' ## Authors ORCID and bio
-#' 
-#' Author ORCID identification numbers in the `DESCRIPTION` are linked using 
+#'
+#' Author ORCID identification numbers in the `DESCRIPTION` are linked using
 #' the ORCID logo:
-#' 
+#'
 #' ```r
 #' Authors@R: c(
 #'     person("Hadley", "Wickham", , "[email protected]", role = c("aut", "cre"),
@@ -134,11 +134,11 @@
 #'     )
 #'   )
 #' ```
-#' 
-#' If you want to add more details about authors or their involvement with the 
-#' package, you can use the comment field, which will be rendered on the 
+#'
+#' If you want to add more details about authors or their involvement with the
+#' package, you can use the comment field, which will be rendered on the
 #' authors page.
-#' 
+#'
 #' ```r
 #' Authors@R: c(
 #'     person("Hadley", "Wickham", , "[email protected]", role = c("aut", "cre"),
@@ -149,49 +149,49 @@
 #'     )
 #'   )
 #' ```
-#' 
+#'
 #' ## Additional control via YAML
-#' 
-#' You can control additinal aspects of the authors display via the `authors` 
+#'
+#' You can control additinal aspects of the authors display via the `authors`
 #' YAML field:
-#' 
+#'
 #' * display of each author in the footer, sidebar and authors page,
 #' * which authors (by role) are displayed in the sidebar and footer,
-#' * text before authors in the footer, 
+#' * text before authors in the footer,
 #' * text before and after authors in the sidebar,
 #' * text before and after authors on the authors page.
-#' 
-#' You can modify how each author's name is displayed by adding a subsection 
-#' for `authors`. Each entry in `authors` should be named the author's name 
+#'
+#' You can modify how each author's name is displayed by adding a subsection
+#' for `authors`. Each entry in `authors` should be named the author's name
 #' (matching `DESCRIPTION`) and can contain `href` and/or `html` fields:
-#' 
+#'
 #' * If `href` is provided, the author's name will be linked to this URL.
 #' * If `html` is provided, it will be shown instead of the author's name.
 #'   This is particularly useful if you want to display the logo of a corporate
-#'   sponsor. Use an absolute URL to an image, not a relative link. Use an empty 
-#'   alternative text rather than no alternative text so a screen-reader would 
+#'   sponsor. Use an absolute URL to an image, not a relative link. Use an empty
+#'   alternative text rather than no alternative text so a screen-reader would
 #' skip over it.
-#' 
+#'
 #' ```yaml
 #' authors:
 #'   firstname lastname:
 #'     href: "http://name-website.com"
 #'     html: "<img src='https://website.com/name-picture.png' width=72 alt=''>"
 #' ```
-#' 
-#' 
-#' By default, the "developers" list shown in the sidebar and footer is 
-#' populated by the maintainer ("cre"), authors ("aut"), and funder ("fnd") 
+#'
+#'
+#' By default, the "developers" list shown in the sidebar and footer is
+#' populated by the maintainer ("cre"), authors ("aut"), and funder ("fnd")
 #' from the `DESCRIPTION`. You could choose other roles for filtering.
 #' With the configuration below:
-#' 
-#' * only the maintainer and funder(s) appear in the footer, after the text 
+#'
+#' * only the maintainer and funder(s) appear in the footer, after the text
 #'   "Crafted by",
 #' * all authors and contributors appear in the sidebar,
 #' * the authors list on the sidebar is preceded and followed by some text,
 #' * the authors list on the authors page is preceded and followed by some text.
-#' 
-#' 
+#'
+#'
 #' ```yaml
 #' authors:
 #'   footer:
@@ -204,32 +204,32 @@
 #'   before: "This package is proudly brought to you by:"
 #'   after: "See the [changelog](news/index.html) for other contributors. :pray:"
 #' ```
-#' 
-#' If you want to filter authors based on something else than their roles, 
-#' consider using a custom sidebar/footer component 
+#'
+#' If you want to filter authors based on something else than their roles,
+#' consider using a custom sidebar/footer component
 #' (see `?build_home`/`?build_site`, respectively).
-#' 
+#'
 #' # Sidebar
-#' 
+#'
 #' You can customise the homepage sidebar with the `home.sidebar` field.
-#' It's made up of two pieces: `structure`, which defines the overall layout, 
-#' and `components`, which defines what each piece looks like. This organisation 
-#' makes it easy to mix and match the pkgdown defaults with your own 
+#' It's made up of two pieces: `structure`, which defines the overall layout,
+#' and `components`, which defines what each piece looks like. This organisation
+#' makes it easy to mix and match the pkgdown defaults with your own
 #' customisations.
-#' 
+#'
 #' This is the default structure:
-#' 
+#'
 #' ``` yaml
 #' home:
 #'   sidebar:
 #'     structure: [links, license, community, citation, authors, dev]
 #' ```
-#' 
+#'
 #' These are drawn from seven built-in components:
-#' 
-#' -   `links`: automated links generated from `URL` and `BugReports` fields 
+#'
+#' -   `links`: automated links generated from `URL` and `BugReports` fields
 #'     from `DESCRIPTION` plus manual links from the `home.links` field:
-#' 
+#'
 #'     ``` yaml
 #'     home:
 #'       links:
@@ -238,26 +238,26 @@
 #'       - text: Roadmap
 #'         href: /roadmap.html
 #'     ```
-#' 
-#' -   `license`: Licensing information if `LICENSE`/`LICENCE` or 
+#'
+#' -   `license`: Licensing information if `LICENSE`/`LICENCE` or
 #'     `LICENSE.md`/`LICENCE.md` files are present.
-#' 
-#' -   `community`: links to to `.github/CONTRIBUTING.md`, 
+#'
+#' -   `community`: links to to `.github/CONTRIBUTING.md`,
 #'     `.github/CODE_OF_CONDUCT.md`, etc.
-#' 
-#' -   `citation`: link to package citation information. Uses either 
+#'
+#' -   `citation`: link to package citation information. Uses either
 #'     `inst/CITATION` or, if absent, information from the `DESCRIPTION`.
-#' 
+#'
 #' -   `authors`: selected authors from the `DESCRIPTION`.
-#' 
-#' -   `dev`: development status badges extracted from `README.md`/`index.md`. 
-#'     This is only shown for "development" versions of websites; see 
-#'     "Development mode" in `?build_site` for details. 
-#' 
+#'
+#' -   `dev`: development status badges extracted from `README.md`/`index.md`.
+#'     This is only shown for "development" versions of websites; see
+#'     "Development mode" in `?build_site` for details.
+#'
 #' -   `toc`: a table of contents for the README (not shown by default).
-#' 
+#'
 #' You can also add your own components, where `text` is markdown text:
-#' 
+#'
 #' ``` yaml
 #' home:
 #'   sidebar:
@@ -267,17 +267,17 @@
 #'         title: Funding
 #'         text: We are *grateful* for funding!
 #' ```
-#' 
+#'
 #' Alternatively, you can provide a ready-made sidebar HTML:
-#' 
+#'
 #' ``` yaml
 #' home:
 #'   sidebar:
 #'     html: path-to-sidebar.html
 #' ```
-#' 
+#'
 #' Or completely remove it:
-#' 
+#'
 #' ``` yaml
 #' home:
 #'   sidebar: FALSE