Rename refrepl to replace_reference to improve clarity (hellt#9)

* Rename refrepl to reference_replace to improve clarity

* Change function name to be replace_reference (verb, then noun)

Author: mjbear

fnsort.py

@@ -42,7 +42,7 @@ def parse_arguments():
 label = re.compile(r"^\[\^([^\]]+)\]:\s*((?:(?!\n\[)[\s\S])*)", re.MULTILINE)
 
 
-def refrepl(m, order):
+def replace_reference(m, order):
     # Rewrite reference links with the reordered link numbers. Insert the first
     # character from the footnote reference link right before the new link.
     return f"{m.group(0)[:1]}[^{order.index(m.group(2)) + 1}]"
@@ -75,7 +75,7 @@ def sort_footnotes(text):
     # print(f"text: {text}")
 
     # Rewrite the footnote-links with the new footnote-reference numbers.
-    text = link.sub(lambda m: refrepl(m, order), text)
+    text = link.sub(lambda m: replace_reference(m, order), text)
 
     return text
 

tests/test_footnote_sorting.py

@@ -30,7 +30,7 @@ def test_replace_reference(self):
 
         # hedgehogs[^1]
         self.assertEqual(
-            fnsort.refrepl(match, order),
+            fnsort.replace_reference(match, order),
             "s[^1]"
         )
 
@@ -69,7 +69,7 @@ def test_replace_references_with_dups(self):
         # multiple assertions
         for i, match in enumerate(matches):
             self.assertEqual(
-                fnsort.refrepl(match, order),
+                fnsort.replace_reference(match, order),
                 expected[i]
             )