diff options
| author | Asko Nõmm <asko@bien.ee> | 2022-04-23 02:42:52 +0300 |
|---|---|---|
| committer | Asko Nõmm <asko@bien.ee> | 2022-04-23 02:42:52 +0300 |
| commit | dc921cbe1c786995a8670efd9f5556ee9df064f9 (patch) | |
| tree | b371f12617949daf2b40538ba9a2e4457b657d0f | |
| parent | 905e923ede7f0ef433c40561b478cf33a8766700 (diff) | |
Add docstrings
| -rw-r--r-- | src/clarktown/correctors/atx_heading_block.clj | 12 | ||||
| -rw-r--r-- | src/clarktown/correctors/code_block.clj | 10 |
2 files changed, 21 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) "")))) diff --git a/src/clarktown/correctors/code_block.clj b/src/clarktown/correctors/code_block.clj index 9b2f0f3..73989fe 100644 --- a/src/clarktown/correctors/code_block.clj +++ b/src/clarktown/correctors/code_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 + code block, which starts with three backticks (```), 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) @@ -16,6 +21,11 @@ (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 + code block, which ends with three backticks (```), 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 (- (count lines) 1)) |