From 3b95173bc05cce78c3cfad10a5486999798342de Mon Sep 17 00:00:00 2001
From: McAuley Penney <134115@gmail.com>
Date: Mon, 20 Dec 2021 18:12:52 -0700
Subject: [PATCH] chore, docs:

    - update section that discusses what the
      script does

    - add a few comments and organize patterns
---
 README.md         |  8 +++++---
 lua/tidy/init.lua | 16 ++++++++--------
 2 files changed, 13 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index 22c6ada..6456e2a 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,11 @@
 # tidy.nvim 🧹
 
-A function and autocommand pair that removes all
+A function and autocommand pair that can
 
-    - trailing whitespace
-    - empty lines at the end of the buffer
+    - remove all empty lines at the top of the buffer
+    - remove all trailing whitespace
+    - remove a variable amount of empty lines at the end of the buffer
+    - condense multiple empty lines into one
 
 on every `BufWritePre`.
 
diff --git a/lua/tidy/init.lua b/lua/tidy/init.lua
index 3ade149..3eaa45a 100644
--- a/lua/tidy/init.lua
+++ b/lua/tidy/init.lua
@@ -11,7 +11,6 @@ local M = {
 }
 
 function M.setup(user_config)
-
     -- integrate user configuration
     M.config = vim.tbl_deep_extend("force", M.config, user_config or {})
 
@@ -27,22 +26,23 @@ function M.tidy_up()
     local cmd_mods = ":keepjumps keeppatterns silent! "
 
     local patterns = {
-        -- delete all new lines at beginning of file
-
-        sof = [[%s/\%^\n*/]],
-        -- delete all lines at end of buffer, see source 2
-
+        -- delete all lines at end of buffer, see sources
         eof = [[0;/^\%(\n*.\)\@!/ + ]] .. M.config.eof_quant ..  ",$d",
-        -- compress all instances of multiple newlines into one
 
+        -- compress all instances of multiple newlines into one, see sources
         multi = [[:%s/\n\{2,}/\r\r/e]],
-        -- delete all whitespace, see source 1
+
+        -- delete all new lines at beginning of file
+        sof = [[%s/\%^\n*/]],
+
+        -- delete all whitespace, see sources
         ws = [[%s/\s\+$//e]]
     }
 
     -- get tuple of cursor position before making changes
     local pos = vim.api.nvim_win_get_cursor(0)
 
+    -- execute chosen patterns
     for _, fmt_type in ipairs(M.config.fmts) do
         vim.cmd(cmd_mods .. patterns[fmt_type])
     end