Merge pull request #795 from uribo/patch_gh

[FIX]correct name for GitHub

Author: hadley

R/doctor.R

@@ -58,7 +58,7 @@ dr_devtools <- function() {
   doctor("devtools", msg)
 }
 
-#' Diagnose potential github issues
+#' Diagnose potential GitHub issues
 #'
 #' @param path Path to repository to check. Defaults to current working
 #'   directory

R/git.R

@@ -88,7 +88,7 @@ github_remote_parse <- function(x) {
     # [email protected]:hadley/devtools.git
     re <- "github.com:(.*?)/(.*)\\.git"
   } else {
-    stop("Unknown github repo format", call. = FALSE)
+    stop("Unknown GitHub repo format", call. = FALSE)
   }
 
   m <- regexec(re, x)

R/infrastructure-git.R

@@ -27,7 +27,7 @@ use_git <- function(message = "Initial commit", pkg = ".") {
   invisible()
 }
 
-#' Connect a local repo with github.
+#' Connect a local repo with GitHub.
 #'
 #' If the current repo does not use git, calls \code{use_git} automatically.
 #'
@@ -49,15 +49,15 @@ use_github <- function(auth_token = github_pat(), private = FALSE, pkg = ".") {
   if ("origin" %in% git2r::remotes(r))
     return(invisible())
 
-  message("Creating github repository")
+  message("Creating GitHub repository")
 
   create <- github_POST("user/repos", pat = auth_token, body = list(
     name = jsonlite::unbox(pkg$package),
     description = jsonlite::unbox(pkg$description),
     private = jsonlite::unbox(private)
   ))
 
-  message("Adding remote to github")
+  message("Adding remote to GitHub")
   git2r::remote_add(r, "origin", create$ssh_url)
   # git2r::branch_set_upstream(head(r), "origin/master")
   # git2r::push(r, "origin", "refs/heads/master")

R/install-github.r

@@ -1,4 +1,4 @@
-#' Attempts to install a package directly from github.
+#' Attempts to install a package directly from GitHub.
 #'
 #' This function is vectorised on \code{repo} so you can install multiple
 #' packages in a single command.
@@ -18,7 +18,7 @@
 #'   supply to this argument. This is safer than using a password because
 #'   you can easily delete a PAT without affecting any others. Defaults to
 #'   the \code{GITHUB_PAT} environment variable.
-#' @param host Github API host to use. Override with your github enterprise
+#' @param host GitHub API host to use. Override with your GitHub enterprise
 #'   hostname, for example, \code{"github.hostname.com/api/v3"}.
 #' @param ... Other arguments passed on to \code{\link{install}}.
 #' @details
@@ -89,7 +89,7 @@ github_remote <- function(repo, username = NULL, ref = NULL, subdir = NULL,
 #' @export
 remote_download.github_remote <- function(x, quiet = FALSE) {
   if (!quiet) {
-    message("Downloading github repo ", x$username, "/", x$repo, "@", x$ref)
+    message("Downloading GitHub repo ", x$username, "/", x$repo, "@", x$ref)
   }
 
   dest <- tempfile(fileext = paste0(".zip"))
@@ -107,7 +107,7 @@ remote_download.github_remote <- function(x, quiet = FALSE) {
   }
 
   if (github_has_remotes(x, auth))
-    warning("Github repo contains submodules, may not function as expected!",
+    warning("GitHub repo contains submodules, may not function as expected!",
       call. = FALSE)
 
   download(dest, src, auth)

man/install_github.Rd

@@ -2,7 +2,7 @@
 % Please edit documentation in R/install-github.r
 \name{install_github}
 \alias{install_github}
-\title{Attempts to install a package directly from github.}
+\title{Attempts to install a package directly from GitHub.}
 \usage{
 install_github(repo, username = NULL, ref = "master", subdir = NULL,
   auth_token = github_pat(), host = "api.github.com", ...)
@@ -28,7 +28,7 @@ supply to this argument. This is safer than using a password because
 you can easily delete a PAT without affecting any others. Defaults to
 the \code{GITHUB_PAT} environment variable.}
 
-\item{host}{Github API host to use. Override with your github enterprise
+\item{host}{GitHub API host to use. Override with your GitHub enterprise
 hostname, for example, \code{"github.hostname.com/api/v3"}.}
 
 \item{...}{Other arguments passed on to \code{\link{install}}.}

man/use_github.Rd

@@ -2,7 +2,7 @@
 % Please edit documentation in R/infrastructure-git.R
 \name{use_github}
 \alias{use_github}
-\title{Connect a local repo with github.}
+\title{Connect a local repo with GitHub.}
 \usage{
 use_github(auth_token = github_pat(), private = FALSE, pkg = ".")
 }