updated documentation on the new \abjad command

1 files changed, 9 insertions, 6 deletions

diff --git a/arabluatex.lua b/arabluatex.lua
index 102974a..0f3984b 100644
--- a/arabluatex.lua
+++ b/arabluatex.lua
@@ -388,24 +388,27 @@ local abjad = {
 {".g"}
 }
 
+-- this function is adapted from an 'obsolete project' of Khaled
+-- Hosny's that dates back to 2010. Thanks to him.
+-- See https://github.com/khaledhosny/lualatex-arabic
 function abjadify(n)
-    local result = ""
+    local abjadnum = ""
     if n >= 1000 then
         for i=1,math.floor(n/1000) do
-            result = result .. abjad[4][1]
+            abjadnum = abjadnum .. abjad[4][1]
         end
         n = math.fmod(n,1000)
     end
     if n >= 100 then
-        result = result .. abjad[3][math.floor(n/100)]
+        abjadnum = abjadnum .. abjad[3][math.floor(n/100)]
         n = math.fmod(n, 100)
     end
     if n >= 10 then
-        result = result .. abjad[2][math.floor(n/10)]
+        abjadnum = abjadnum .. abjad[2][math.floor(n/10)]
         n = math.fmod(n, 10)
     end
     if n >= 1 then
-        result = result .. abjad[1][math.floor(n/1)]
+        abjadnum = abjadnum .. abjad[1][math.floor(n/1)]
     end
-    return "\\arb{"..result.."}"
+    return "\\arb{"..abjadnum.."}"
 end