summaryrefslogtreecommitdiff
path: root/snakemake.el
diff options
context:
space:
mode:
authorKyle Meyer <kyle@kyleam.com>2016-04-17 18:59:32 -0400
committerKyle Meyer <kyle@kyleam.com>2016-04-17 19:05:03 -0400
commit5c5a31aacb0e6c79646b316b7e6c02f68f7c7912 (patch)
tree5756a9bd02cfbd4cb2984546276def80d5dfaf78 /snakemake.el
parent51a2dd659e7c738899980f79d1cdcbda8213e90f (diff)
downloadsnakemake-mode-5c5a31aacb0e6c79646b316b7e6c02f68f7c7912.tar.gz
commentary: Mention how Snakefile is located
Diffstat (limited to 'snakemake.el')
-rw-r--r--snakemake.el7
1 files changed, 7 insertions, 0 deletions
diff --git a/snakemake.el b/snakemake.el
index 43a7a01..f2ca732 100644
--- a/snakemake.el
+++ b/snakemake.el
@@ -68,6 +68,13 @@
;; It outputs a list of all concrete output files for the current
;; Snakefile.
;;
+;; All these commands use the Snakefile contained in the
+;; `default-directory' of the current buffer. If
+;; `snakemake-root-dir-function' is non-nil, this function should
+;; return a secondary directory (e.g., a project repository root) in
+;; which to look for a Snakefile if there isn't one in the current
+;; directory.
+;;
;; In addition to the popup commands, there are commands for showing
;; and saving the dependency graph of a target. The command
;; `snakemake-graph' displays the graph in a buffer. From this