From 51e5afc41a5a3a465afdd81a70e5354c51b1a7dc Mon Sep 17 00:00:00 2001
From: Till Hartmann <till.hartmann@udo.edu>
Date: Fri, 24 Sep 2021 14:14:21 +0200
Subject: [PATCH] add information about min rust-script version + conda env
 yaml (#1175)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Co-authored-by: Johannes Köster <johannes.koester@uni-due.de>
---
 docs/snakefiles/rules.rst | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/docs/snakefiles/rules.rst b/docs/snakefiles/rules.rst
index f5d0d4a5d..8d086a835 100644
--- a/docs/snakefiles/rules.rst
+++ b/docs/snakefiles/rules.rst
@@ -736,6 +736,8 @@ Rust_
             "path/to/another/outputfile"
         params:
             seed=4
+        conda:
+            "rust.yaml"
         log:
             stdout="path/to/stdout.log",
             stderr="path/to/stderr.log",
@@ -745,6 +747,17 @@ Rust_
 The ability to execute Rust scripts is facilitated by |rust-script|_. As such, the
 script must be a valid ``rust-script`` script and ``rust-script`` must be available in the
 environment the rule is run in.
+The minimum required ``rust-script`` version is `1.15.0`, so in the example above, the contents of ``rust.yaml`` might look like this:
+
+.. code block:: yaml
+
+    channels:
+      - conda-forge
+      - bioconda
+    dependencies:
+      - rust-script>=0.15.0
+
+
 
 Some example scripts can be found in the
 `tests directory <https://github.com/snakemake/snakemake/tree/main/tests/test_script/scripts>`_.