Polish docs

R/bash.R

@@ -1,4 +1,4 @@
-#' Open bash shell in package directory.
+#' Open bash shell in package directory
 #'
 #' @template devtools
 #' @export

R/check-devtools.R

@@ -1,4 +1,4 @@
-#' Custom devtools release checks.
+#' Custom devtools release checks
 #'
 #' This function performs additional checks prior to release. It is called
 #' automatically by [release()].

R/check-doc.R

@@ -1,4 +1,4 @@
-#' Check documentation, as `R CMD check` does.
+#' Check documentation, as `R CMD check` does
 #'
 #' This function attempts to run the documentation related checks in the
 #' same way that `R CMD check` does. Unfortunately it can't run them

R/check-git.R

@@ -1,4 +1,4 @@
-#' Git checks.
+#' Git checks
 #'
 #' This function performs Git checks checks prior to release. It is called
 #' automatically by [release()].

R/document.R

@@ -1,4 +1,4 @@
-#' Use roxygen to document a package.
+#' Use roxygen to document a package
 #'
 #' This function is a wrapper for the [roxygen2::roxygenize()]
 #' function from the roxygen2 package. See the documentation and vignettes of

R/install.R

@@ -1,4 +1,4 @@
-#' Install a local development package.
+#' Install a local development package
 #'
 #' Uses `R CMD INSTALL` to install the package. Will also try to install
 #' dependencies of the package from CRAN, if they're not already installed.
@@ -148,7 +148,7 @@ install <-
     invisible(TRUE)
   }
 
-#' Install package dependencies if needed.
+#' Install package dependencies if needed
 #'
 #' `install_deps()` will install the
 #' user dependencies needed to run the package, `install_dev_deps()` will also

R/missing-s3.R

@@ -1,4 +1,4 @@
-#' Find missing s3 exports.
+#' Find missing s3 exports
 #'
 #' The method is heuristic - looking for objs with a period in their name.
 #'

R/package.R

@@ -1,4 +1,4 @@
-#' Coerce input to a package.
+#' Coerce input to a package
 #'
 #' Possible specifications of package:
 #' \itemize{
@@ -21,7 +21,7 @@ as.package <- function(x = NULL, create = deprecated()) {
   load_pkg_description(x)
 }
 
-#' Find file in a package.
+#' Find file in a package
 #'
 #' It always starts by walking up the path until it finds the root directory,
 #' i.e. a directory containing `DESCRIPTION`. If it cannot find the root

R/release.R

@@ -1,4 +1,4 @@
-#' Release package to CRAN.
+#' Release package to CRAN
 #'
 #' @description
 #' `r lifecycle::badge("deprecated")`

R/reload.R

@@ -1,4 +1,4 @@
-#' Unload and reload package.
+#' Unload and reload package
 #'
 #' This attempts to unload and reload an _installed_ package. If the package is
 #' not loaded already, it does nothing. It's not always possible to cleanly

R/revdep.R

@@ -1,4 +1,4 @@
-#' Reverse dependency tools.
+#' Reverse dependency tools
 #'
 #' Tools to check and notify maintainers of all CRAN and Bioconductor
 #' packages that depend on the specified package.

R/run-examples.R

@@ -1,4 +1,4 @@
-#' Run all examples in a package.
+#' Run all examples in a package
 #'
 #' One of the most frustrating parts of `R CMD check` is getting all of your
 #' examples to pass - whenever one fails you need to fix the problem and then

R/run-source.R

@@ -1,4 +1,4 @@
-#' Run a script through some protocols such as http, https, ftp, etc.
+#' Run a script through some protocols such as http, https, ftp, etc
 #'
 #' If a SHA-1 hash is specified with the `sha1` argument, then this
 #' function will check the SHA-1 hash of the downloaded file to make sure it

R/save-all.R

@@ -1,4 +1,4 @@
-#' Save all documents in an active IDE session.
+#' Save all documents in an active IDE session
 #'
 #' Helper function wrapping IDE-specific calls to save all documents in the
 #' active session. In this form, callers of `save_all()` don't need to

R/wd.R

@@ -1,4 +1,4 @@
-#' Set working directory.
+#' Set working directory
 #'
 #' @template devtools
 #' @param path path within package. Leave empty to change working directory

R/zzz.R

@@ -5,7 +5,7 @@
 #' @import fs
 NULL
 
-#' Deprecated Functions
+#' Deprecated functions
 #'
 #' These functions are Deprecated in this release of devtools, they will be
 #' marked as Defunct and removed in a future version.

_pkgdown.yml

@@ -15,7 +15,7 @@ development:
   mode: auto
 
 reference:
-- title: Package Development
+- title: Package development
   desc: Primary commands used when developing a package.
   contents:
   - build
@@ -30,10 +30,12 @@ reference:
   - reload
   - spell_check
   - test
-- title: Package Installation
+
+- title: Package installation
   contents:
   - starts_with("install")
   - uninstall
+
 - title: Utilities
   contents:
   - bash
@@ -48,6 +50,7 @@ reference:
   - update_packages
   - wd
   - save_all
+
 - title: Deprecated functions
   contents:
   - build_vignettes