diff options
| author | Kyle Meyer <kyle@kyleam.com> | 2015-03-05 23:01:16 -0500 |
|---|---|---|
| committer | Kyle Meyer <kyle@kyleam.com> | 2015-03-05 23:01:16 -0500 |
| commit | 19e82c71aa6925482b3ae18d3e4f2724be141080 (patch) | |
| tree | 8eeaa5bac04106a31aed3435dd901d87aa9f76cf | |
| parent | 7552b0ac316b6593480c84f2c34a99bc30367015 (diff) | |
| download | snakemake-mode-19e82c71aa6925482b3ae18d3e4f2724be141080.tar.gz | |
Reword docstrings for predicate functions
| -rw-r--r-- | snakemake-mode.el | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/snakemake-mode.el b/snakemake-mode.el index dc43d7b..6db15fb 100644 --- a/snakemake-mode.el +++ b/snakemake-mode.el @@ -172,7 +172,7 @@ rule blocks (or on a blank line directly below), call (forward-to-indentation 0))) (defun snakemake-in-rule-or-subworkflow-block-p () - "Return t if point is in block or on first blank line following one." + "Return non-nil if point is in block or on first blank line following one." (save-excursion (beginning-of-line) (when (looking-at-p "^ *$") @@ -183,14 +183,14 @@ rule blocks (or on a blank line directly below), call (not (re-search-forward "^ *$" start t)))))) (defun snakemake-run-field-first-line-p () - "Return t if point is on the first line below a run field key." + "Return non-nil if point is on the first line below a run field key." (save-excursion (forward-line -1) (beginning-of-line) (looking-at-p "^[ \t]+run:"))) (defun snakemake-run-field-line-p () - "Return t if point is on any line below a run field key. + "Return non-nil if point is on any line below a run field key. This function assumes that point is in a rule or subworkflow block (which includes being on a blank line immediately below a block). If it's not, it gives the wrong answer if below a rule |