From d1cc481a7af9e902c7dcedcc383a70ea64b3b08f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20Bana=C5=9B?= <74212933+maciekbanas@users.noreply.github.com> Date: Tue, 14 Jan 2025 13:52:28 +0100 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Karolina Marcinkowska <32685910+marcinkowskak@users.noreply.github.com> --- R/get_files.R | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/R/get_files.R b/R/get_files.R index 67b0362f..ac7f7dfc 100644 --- a/R/get_files.R +++ b/R/get_files.R @@ -23,15 +23,15 @@ #' @details `get_files()` may be used in two ways: either with `pattern` (with #' optional `depth`) or `file_path` argument defined. #' -#' In the first scenario `GitStats` will pull first a files structure +#' In the first scenario, `GitStats` will pull first a files structure #' responding to the passed `pattern` and `depth` arguments and afterwards -#' files content for all of these files. In the second scenario `GitStats` -#' will pull only the content of files for the given `file_path` of the +#' files content for all of these files. In the second scenario, `GitStats` +#' will pull only the content of files for the specific `file_path` of the #' repository. #' #' If user wants to pull a particular file or files, a `file_path` approach -#' seems to more reasonable, a it is a faster way (it omits pulling the whole -#' file structure from the repo). +#' seems more reasonable, as it is a faster since it omits pulling the whole +#' file structure from the repo. #' #' For example, if user wants to pull content of `README.md` and/or `NEWS.md` #' files placed in the `root` directories of the repositories, he should take