R/md-issue.R

In gluedown: Wrap Vectors in Markdown Formatting

#' Markdown GitHub issue
#'
#' Take a character vector and numeric vector and concatenate them into a glue
#' vector of valid GitHub issue autolinks (username/repo#issue).
#'
#' @details
#' Within conversations on GitHub, references to issues and pull requests are
#' [automatically converted to shortened links](https://git.io/Jvtb9).
#' @param repo A character vector in the format `"user/rep"`.
#' @param num The issue or pull number _without_ hash symbol.
#' @return A character vector which GitHub can automatically hyperlink.
#' @family inline functions
#' @family markdown extensions
#' @examples
#' md_issue("kiernann/gluedown", 1:5)
#' @export
md_issue <- function(repo, num) {
  if (suppressWarnings(any(is.na(as.numeric(num))))) {
    stop("The num must be coercible to numeric.")
  }
  if (!grepl("/", repo)) {
    warning("use the \"user/repo\" format")
  }
  glue::glue("{repo}#{num}")
}