Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Karolina Marcinkowska <32685910+marcinkowskak@users.noreply.github.com>
  • Loading branch information
maciekbanas and marcinkowskak authored Jan 14, 2025
1 parent 8e390d0 commit d1cc481
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions R/get_files.R
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit d1cc481

Please sign in to comment.