summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKyle Meyer <kyle@kyleam.com>2015-01-01 22:59:54 -0500
committerKyle Meyer <kyle@kyleam.com>2015-01-09 23:53:40 -0500
commit69bc72f551c46feae74a8b59d63096a164eeaa1a (patch)
tree2d15d75ef18fc942641e9c3d05ebac77ff28db54
parente146047bd597cbfa7300bc1779ce044fb2de9469 (diff)
downloadsnakemake-mode-69bc72f551c46feae74a8b59d63096a164eeaa1a.tar.gz
snakemake-previous-field-value-column: Expand docstring
-rw-r--r--snakemake-mode.el7
1 files changed, 6 insertions, 1 deletions
diff --git a/snakemake-mode.el b/snakemake-mode.el
index ecb215f..e8a146a 100644
--- a/snakemake-mode.el
+++ b/snakemake-mode.el
@@ -206,9 +206,14 @@ block whose last field is 'run'."
(defun snakemake-previous-field-value-column ()
"Get column for previous field value.
+
If directly below a field key, this corresponds to the column for
the first non-blank character after 'key:'. Otherwise, it is the
-column of the first non-blank character."
+column of the first non-blank character.
+
+This function assumes that the previous line is a field value (in
+other words, that point is at or beyond the third line of a rule
+or subworkflow block."
(save-excursion
(forward-line -1)
(beginning-of-line)