From 9537be8d1037703467348e54c8a5e9a6749a7d83 Mon Sep 17 00:00:00 2001 From: Maciej Banas Date: Tue, 14 Jan 2025 12:53:53 +0000 Subject: [PATCH] Last typo and roxygenize. --- R/get_files.R | 4 ++-- man/get_files.Rd | 10 +++++----- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/R/get_files.R b/R/get_files.R index ac7f7dfc..17405c81 100644 --- a/R/get_files.R +++ b/R/get_files.R @@ -30,8 +30,8 @@ #' repository. #' #' If user wants to pull a particular file or files, a `file_path` approach -#' seems more reasonable, as it is a faster since it omits pulling the whole -#' file structure from the repo. +#' seems more reasonable, as it is a faster way 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 diff --git a/man/get_files.Rd b/man/get_files.Rd index 1fbc165a..56fc8162 100644 --- a/man/get_files.Rd +++ b/man/get_files.Rd @@ -51,15 +51,15 @@ Pulls text files and their content. \code{get_files()} may be used in two ways: either with \code{pattern} (with optional \code{depth}) or \code{file_path} argument defined. -In the first scenario \code{GitStats} will pull first a files structure +In the first scenario, \code{GitStats} will pull first a files structure responding to the passed \code{pattern} and \code{depth} arguments and afterwards -files content for all of these files. In the second scenario \code{GitStats} -will pull only the content of files for the given \code{file_path} of the +files content for all of these files. In the second scenario, \code{GitStats} +will pull only the content of files for the specific \code{file_path} of the repository. If user wants to pull a particular file or files, a \code{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 way since it omits pulling the +whole file structure from the repo. For example, if user wants to pull content of \code{README.md} and/or \code{NEWS.md} files placed in the \code{root} directories of the repositories, he should take