From c348f3625f7879436f0034dcb77b3e72cbb45d7e Mon Sep 17 00:00:00 2001
From: Ismo Vuorinen <ismo@ivuorinen.net>
Date: Wed, 4 Jun 2025 11:00:42 +0300
Subject: [PATCH] chore(lint): fix replacable helper typo (#116)

* Fix typo in replaceable helper

* chore(docs): add docstrings to `codex/rename-replacable-to-replaceable-and-update-references` (#117)

Docstrings generation was requested by @ivuorinen.

* https://github.com/ivuorinen/dotfiles/pull/116#issuecomment-2938946257

The following files were modified:

* `scripts/install-cheat-purebashbible.sh`

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
---
 config/exports                         |  2 +-
 scripts/install-cheat-purebashbible.sh | 18 +++++++++++++++++-
 2 files changed, 18 insertions(+), 2 deletions(-)
 mode change 100755 => 100644 scripts/install-cheat-purebashbible.sh

diff --git a/config/exports b/config/exports
index 12e0d20..a84f500 100755
--- a/config/exports
+++ b/config/exports
@@ -213,7 +213,7 @@ get_sha256sum()
 # $2 - filename (string)
 #
 # Returns 1 when replaceable, 0 when not replaceable.
-replacable()
+replaceable()
 {
   FILE1="$1"
   FILE2="$2"
diff --git a/scripts/install-cheat-purebashbible.sh b/scripts/install-cheat-purebashbible.sh
old mode 100755
new mode 100644
index 02e70f3..7dca138
--- a/scripts/install-cheat-purebashbible.sh
+++ b/scripts/install-cheat-purebashbible.sh
@@ -47,6 +47,22 @@ prepare_cheat_dest()
   echo "$cheat_dest"
 }
 
+# Processes chapter files from the pure-bash-bible repository and generates or updates corresponding cheat sheets.
+#
+# For each chapter file, creates or updates a cheat sheet in the appropriate destination directory, removes chapter end markers, and ensures required metadata is present.
+#
+# Globals:
+# * PBB_TEMP_DIR: Directory containing the cloned pure-bash-bible repository.
+# * PBB_SYNTAX, PBB_TAGS, PBB_SOURCE: Metadata strings for cheat sheets.
+#
+# Outputs:
+# * Writes or updates cheat sheet files in the determined cheat sheet directory.
+#
+# Example:
+#
+# ```bash
+# process_chapters
+# ```
 process_chapters()
 {
   local cheat_dest
@@ -59,7 +75,7 @@ process_chapters()
     header=$(grep -e '^[#] ' "$f" | head -1 | awk '{print tolower($2)}')
     cheat_file="$cheat_dest/$header"
 
-    if ! replacable "$f" "$cheat_file"; then
+    if ! replaceable "$f" "$cheat_file"; then
       cp "$f" "$cheat_file" && msg_run "Updated: $cheat_file"
     fi