From 540b2200afb68a3282419ffb6c49bbf8f642b67e Mon Sep 17 00:00:00 2001
From: Carlo Sala <carlosalag@protonmail.com>
Date: Tue, 18 Jan 2022 18:46:14 +0100
Subject: feat(sudo): respect `$SUDO_EDITOR` and `$VISUAL`, switch to `sudo -e`
 (#10596)

---
 plugins/sudo/README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

(limited to 'plugins/sudo/README.md')

diff --git a/plugins/sudo/README.md b/plugins/sudo/README.md
index 012fc5325..27cd20c18 100644
--- a/plugins/sudo/README.md
+++ b/plugins/sudo/README.md
@@ -24,6 +24,20 @@ By pressing the <kbd>esc</kbd> key twice, you will have the same command with `s
 $ sudo apt-get install build-essential
 ```
 
+The same happens for editing files with your default editor (defined in `$SUDO_EDITOR`, `$VISUAL` or `$EDITOR`, in that order):
+
+If the editor defined were `vim`:
+
+```console
+$ vim /etc/hosts
+```
+
+By pressing the <kbd>esc</kbd> key twice, you will have the same command with `sudo -e` instead of the editor, that would open that editor with root privileges:
+
+```console
+$ sudo -e /etc/hosts
+```
+
 ### Previous executed commands
 
 Say you want to delete a system file and denied:
@@ -44,6 +58,8 @@ Password:
 $
 ```
 
+The same happens for file editing, as told before.
+
 ## Key binding
 
 By default, the `sudo` plugin uses <kbd>Esc</kbd><kbd>Esc</kbd> as the trigger.
-- 
cgit v1.2.3-70-g09d2