summaryrefslogtreecommitdiff
path: root/src/clarktown/correctors/atx_heading_block.clj
diff options
context:
space:
mode:
Diffstat (limited to 'src/clarktown/correctors/atx_heading_block.clj')
-rw-r--r--src/clarktown/correctors/atx_heading_block.clj12
1 files changed, 11 insertions, 1 deletions
diff --git a/src/clarktown/correctors/atx_heading_block.clj b/src/clarktown/correctors/atx_heading_block.clj
index a792572..9ff789e 100644
--- a/src/clarktown/correctors/atx_heading_block.clj
+++ b/src/clarktown/correctors/atx_heading_block.clj
@@ -4,6 +4,11 @@
(defn empty-line-above?
+ "Determines whether there's a need for an empty new line
+ above the `line` at the current `index`. In the case of a
+ ATX heading block that starts with the `#` character, if
+ there's no empty newline above, we need to create one, and
+ so this function must then return `true`."
[lines line index]
(and (string/starts-with? (string/trim line) "#")
(> index 0)
@@ -12,8 +17,13 @@
(defn empty-line-below?
+ "Determines whether there's a need for an empty new line
+ below the `line` at the current `index`. In the case of a
+ ATX heading block that starts with the `#` character, if
+ there's no empty newline below, we need to create one, and
+ so this function must then return `true`."
[lines line index]
(and (string/starts-with? (string/trim line) "#")
(< index (- (count lines) 1))
(not (= (-> (nth lines (+ index 1))
- string/trim) "")))) \ No newline at end of file
+ string/trim) ""))))