Fix documentation.

R/gitstats_functions.R

@@ -107,6 +107,7 @@ set_gitlab_host <- function(gitstats_object,
 #'   result from its storage.
 #' @param verbose A logical, `TRUE` by default. If `FALSE` messages and printing
 #'   output is switched off.
+#' @return A data.frame.
 #' @examples
 #' \dontrun{
 #' my_gitstats <- create_gitstats() %>%
@@ -147,7 +148,7 @@ get_repos <- function(gitstats_object,
 #'   result from its storage.
 #' @param verbose A logical, `TRUE` by default. If `FALSE` messages and
 #'   printing output is switched off.
-#' @return A `GitStats` class object with commits table.
+#' @return A data.frame.
 #' @examples
 #' \dontrun{
 #' my_gitstats <- create_gitstats() %>%
@@ -227,7 +228,7 @@ get_commits_stats = function(gitstats_object,
 #'   )
 #'  get_users(my_gitstats, c("maciekabanas", "marcinkowskak"))
 #' }
-#' @return A `GitStats` object with table of users.
+#' @return A data.frame.
 #' @export
 get_users <- function(gitstats_object,
                       logins,
@@ -263,7 +264,7 @@ get_users <- function(gitstats_object,
 #'   )
 #'  get_files(my_gitstats, c("LICENSE", "DESCRIPTION"))
 #' }
-#' @return A `GitStats` object with table of files.
+#' @return A data.frame.
 #' @export
 get_files <- function(gitstats_object,
                       file_path,
@@ -289,7 +290,7 @@ get_files <- function(gitstats_object,
 #'   result from its storage.
 #' @param verbose A logical, `TRUE` by default. If `FALSE` messages and
 #'   printing output is switched off.
-#' @return A table of repositories content.
+#' @return A data.frame.
 #' @examples
 #' \dontrun{
 #'  my_gitstats <- create_gitstats() %>%
@@ -320,7 +321,7 @@ get_R_package_usage <- function(
 #' @name get_release_logs
 #' @description Pull release logs from repositories.
 #' @inheritParams get_commits
-#' @return A table with release logs.
+#' @return A data.frame.
 #' @examples
 #' \dontrun{
 #'  my_gitstats <- create_gitstats() %>%