From a1b53e91e79736962a78e8b261f66acb7865ab79 Mon Sep 17 00:00:00 2001 From: Marshall Bowers Date: Tue, 1 Apr 2025 18:19:29 -0400 Subject: [PATCH] git: Use doc comments for `ResetMode` variants (#27882) This PR updates the `ResetMode` enum to use doc comments for its variants instead of line comments. Release Notes: - N/A --- crates/git/src/repository.rs | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/crates/git/src/repository.rs b/crates/git/src/repository.rs index 17f853589d..40a46288ee 100644 --- a/crates/git/src/repository.rs +++ b/crates/git/src/repository.rs @@ -161,13 +161,11 @@ pub struct Remote { } pub enum ResetMode { - // reset the branch pointer, leave index and worktree unchanged - // (this will make it look like things that were committed are now - // staged) + /// Reset the branch pointer, leave index and worktree unchanged (this will make it look like things that were + /// committed are now staged). Soft, - // reset the branch pointer and index, leave worktree unchanged - // (this makes it look as though things that were committed are now - // unstaged) + /// Reset the branch pointer and index, leave worktree unchanged (this makes it look as though things that were + /// committed are now unstaged). Mixed, }