From 8bf7ccc42c96f99dab4b9d7b62731cba32e53f63 Mon Sep 17 00:00:00 2001 From: spaette <111918424+spaette@users.noreply.github.com> Date: Fri, 23 Aug 2024 12:32:45 +0200 Subject: [PATCH] reword (#237) --- DESCRIPTION | 2 +- R/rebase.R | 6 +++--- man/gert-package.Rd | 3 +-- man/git_reset.Rd | 6 +++--- 4 files changed, 8 insertions(+), 9 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 41c2a38..7a66c15 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -32,6 +32,6 @@ VignetteBuilder: knitr Encoding: UTF-8 Roxygen: list(markdown = TRUE) -RoxygenNote: 7.2.3 +RoxygenNote: 7.3.2 SystemRequirements: libgit2 (>= 1.0): libgit2-devel (rpm) or libgit2-dev (deb) Language: en-US diff --git a/R/rebase.R b/R/rebase.R index 00811f9..fac8bda 100644 --- a/R/rebase.R +++ b/R/rebase.R @@ -53,9 +53,9 @@ git_rebase <- function(upstream, commit_changes, repo){ #' Reset your repo to a previous state #' -#' * `git_reset_hard()` reverts to a point in history -#' * `git_reset_soft()` uncommits changes, but keeps the chsange uncommited -#' * `git_reset_mixed()` performs a simple `git reset`. +#' * `git_reset_hard()` resets the index and working tree +#' * `git_reset_soft()` does not touch the index file or the working tree +#' * `git_reset_mixed()` resets the index but not the working tree. #' #' @family git #' @inheritParams git_rebase diff --git a/man/gert-package.Rd b/man/gert-package.Rd index bc29247..da5892c 100644 --- a/man/gert-package.Rd +++ b/man/gert-package.Rd @@ -13,8 +13,7 @@ Simple git client for R based on 'libgit2' \url{https://libgit2.org} with suppor \seealso{ Useful links: \itemize{ - \item \url{https://docs.ropensci.org/gert/} - \item \url{https://github.com/r-lib/gert} + \item \url{https://docs.ropensci.org/gert/ https://ropensci.r-universe.dev/gert} \item Report bugs at \url{https://github.com/r-lib/gert/issues} } diff --git a/man/git_reset.Rd b/man/git_reset.Rd index c669cf5..16a13dd 100644 --- a/man/git_reset.Rd +++ b/man/git_reset.Rd @@ -24,9 +24,9 @@ versions of gert may have additional parameters.} } \description{ \itemize{ -\item \code{git_reset_hard()} reverts to a point in history -\item \code{git_reset_soft()} uncommits changes, but keeps the chsange uncommited -\item \code{git_reset_mixed()} performs a simple \verb{git reset}. +\item \code{git_reset_hard()} resets the index and working tree +\item \code{git_reset_soft()} does not touch the index file or the working tree +\item \code{git_reset_mixed()} resets the index but not the working tree. } } \seealso{