Merge branch 'main' into more-doc

DESCRIPTION

@@ -1,7 +1,7 @@
 Type: Package
 Package: gert
 Title: Simple Git Client for R
-Version: 2.1.0
+Version: 2.1.1
 Authors@R: c(
     person("Jeroen", "Ooms", role = c("aut", "cre"), email = "[email protected]",
       comment = c(ORCID = "0000-0002-4035-0289")),
@@ -32,6 +32,6 @@ VignetteBuilder:
     knitr
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.3.1
+RoxygenNote: 7.3.2
 SystemRequirements: libgit2 (>= 1.0): libgit2-devel (rpm) or libgit2-dev (deb)
 Language: en-US

NEWS

@@ -1,3 +1,6 @@
+2.1.1
+  - No visible changes
+
 2.1.0
   - Workaround for accidental API change in libgit2 1.8.0
   - Refactor authentication callbacks to work around new "non-api"

R/rebase.R

@@ -60,9 +60,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

README.md

@@ -8,7 +8,7 @@
 [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
 ![runiverse-name](https://ropensci.r-universe.dev/badges/:name)
 ![runiverse-package](https://ropensci.r-universe.dev/badges/gert)
-![cran-badge](http://www.r-pkg.org/badges/version/gert)
+![cran-badge](https://www.r-pkg.org/badges/version/gert)
 [![R-CMD-check](https://github.com/r-lib/gert/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/r-lib/gert/actions/workflows/R-CMD-check.yaml)
 <!-- badges: end -->
 
@@ -156,5 +156,5 @@ We provide prebuilt versions of libgit2 for Windows, MacOS and Linux-x86_64 that
   * [libgit2-dev](https://packages.ubuntu.com/focal/libgit2-dev) on Debian/Ubuntu
   * [libgit2-devel](https://src.fedoraproject.org/rpms/libgit2) on Fedora
   * [libgit2](https://archlinux.org/packages/extra/x86_64/libgit2) on Arch Linux
-  * [Homebrew libgit2](https://github.com/Homebrew/homebrew-core/blob/master/Formula/libgit2.rb) on macOS
+  * [Homebrew libgit2](https://github.com/Homebrew/homebrew-core/blob/master/Formula/lib/libgit2.rb) on macOS
   * [rtools40 libgit2](https://github.com/r-windows/rtools-packages/blob/master/mingw-w64-libgit2/PKGBUILD) on Windows