From 3ab71f4d258fd70fb89320d2a7c905d765c403be Mon Sep 17 00:00:00 2001
From: Chris Grieser <73286100+chrisgrieser@users.noreply.github.com>
Date: Fri, 6 Dec 2024 14:29:46 +0100
Subject: [PATCH] chore: improve some comments

---
 README.md                                  | 4 ++--
 lua/various-textobjs/textobjs/charwise.lua | 4 +++-
 2 files changed, 5 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index beb1cfe..8c28cc7 100644
--- a/README.md
+++ b/README.md
@@ -149,8 +149,8 @@ require("various-textobjs").setup {
 	-- extra configuration for specific text objects
 	textobjs = {
 		indentation = {
-			-- `false`: only indentation changes delimit the text object
-			-- `true`: indentation changes as well as blank lines delimit the text object
+			-- `false`: only indentation decreases delimit the text object
+			-- `true`: indentation decreases as well as blank lines delimit the text object
 			blanksAreDelimiter = false,
 		},
 		subword = {
diff --git a/lua/various-textobjs/textobjs/charwise.lua b/lua/various-textobjs/textobjs/charwise.lua
index 12deca1..fa2f14b 100644
--- a/lua/various-textobjs/textobjs/charwise.lua
+++ b/lua/various-textobjs/textobjs/charwise.lua
@@ -6,7 +6,9 @@ local u = require("various-textobjs.utils")
 local forwardLooking = require("various-textobjs.config").config.forwardLooking
 --------------------------------------------------------------------------------
 
--- warn in case user tries to call a textobj that doesn't exist
+-- Warn in case user tries to call a textobj that doesn't exist. 
+-- (Only needed in the module for `charwise` text objects, since it is the catch
+-- all for the `__index` redirect from this plugin's main `init.lua`.)
 setmetatable(M, {
 	__index = function(_, key)
 		return function()