more docs

R/external_setup.R

@@ -1,3 +1,12 @@
+#' Set up the repo for the project
+#' @param git_service git platform to use
+#' @param login login for the git platform
+#' @param protocol protocol to use
+#' @param ci_activation how to activate CI stuff
+#' @param project project name (repo name)
+#' @param title project title (repo description)
+#' @noRd
+
 setup_repo <- function(git_service, login,
                        private, protocol,
                        ci_activation,
@@ -32,7 +41,11 @@ setup_repo <- function(git_service, login,
   }
 }
 
-
+#' Add Travis badge to the README
+#' @param login login (assumed to be the same for the git
+#' platform and Travis)
+#' @param name project name (repo name)
+#' @noRd
 add_travis_badge <- function(login, name) {
   readme_path <- find_readme()
   readme <- readLines(readme_path)

R/github.R

@@ -23,8 +23,9 @@ repo_exists <- function(username, repo) {
 }
 
 #' check whether the repo name is ok i.e. not used
-#' @username account name
-#' @name repo name
+#' @param username account name
+#' @param name repo name
+#' @noRd
 check_github_name <- function(username, name) {
   if (is.null(username)) {
     return(invisible(TRUE))

R/project_health.R

@@ -1,5 +1,9 @@
 #' Create project health report under health
 #'
+#' @details for current working directory.
+#' Aimed at use on CI. It currently includes \code{goodpractice}
+#' and \code{devtools::spell_check()} output.
+#'
 #' @export
 #'
 get_project_health <- function() {

R/repo_status.R

@@ -1,4 +1,6 @@
 # nolint start
+#' Available repostatus.org statuses
+#' @noRd
 statuses <- function() {
   structure(list(status = c(
     "abandoned", "active", "concept", "inactive",
@@ -39,6 +41,10 @@ statuses <- function() {
   ))
 }
 # nolint end
+
+#' Add status badge to README of current project
+#' @param status repostatus.org status
+#' @noRd
 add_repo_status <- function(status) {
   statuses <- statuses()
   if (!status %in% statuses$status) {