Skip to content

Commit 75fff0c

Browse files
committed
doc uodate
1 parent 3e828eb commit 75fff0c

File tree

4 files changed

+12
-4
lines changed

4 files changed

+12
-4
lines changed

docs/_sources/guide.rst.txt

+4-1
Original file line numberDiff line numberDiff line change
@@ -82,14 +82,17 @@ Alternatively, define it with a string.
8282
wf_creator='my_package.my_module.my_wf_creator'
8383
8484
85-
Alternatively, you can use a function contained in a file not in registered module. While this may work, it is **NOT** recommended!
85+
Alternatively, you can use a function contained in a file **not** in registered module. While this may work, it is **NOT** recommended!
8686

8787
**Example**
8888

8989
.. code-block:: python
9090
9191
wf_creator='/path/to/my_module.my_wf_creator'
9292
93+
For this to work, your file needs to be present at this path on all computing resources used for execution. Additionally, this file should be in the PYTHONPATH. Thus it is **HIGHLY RECOMMENDED** you place your wf_creator
94+
somewhere in a python package (e.g., :code:`my_package.my_module.my_other_module.my_wf_creator`) accessible on all the systems you plan to use rocketsled on.
95+
9396

9497
See the basic tutorial or the :code:`examples` folder for examples of writing wf_creator functions.
9598

docs/guide.html

+3-1
Original file line numberDiff line numberDiff line change
@@ -94,11 +94,13 @@ <h3><code class="code docutils literal notranslate"><span class="pre">wf_creator
9494
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">wf_creator</span><span class="o">=</span><span class="s1">&#39;my_package.my_module.my_wf_creator&#39;</span>
9595
</pre></div>
9696
</div>
97-
<p>Alternatively, you can use a function contained in a file not in registered module. While this may work, it is <strong>NOT</strong> recommended!</p>
97+
<p>Alternatively, you can use a function contained in a file <strong>not</strong> in registered module. While this may work, it is <strong>NOT</strong> recommended!</p>
9898
<p><strong>Example</strong></p>
9999
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">wf_creator</span><span class="o">=</span><span class="s1">&#39;/path/to/my_module.my_wf_creator&#39;</span>
100100
</pre></div>
101101
</div>
102+
<p>For this to work, your file needs to be present at this path on all computing resources used for execution. Additionally, this file should be in the PYTHONPATH. Thus it is <strong>HIGHLY RECOMMENDED</strong> you place your wf_creator
103+
somewhere in a python package (e.g., <code class="code docutils literal notranslate"><span class="pre">my_package.my_module.my_other_module.my_wf_creator</span></code>) accessible on all the systems you plan to use rocketsled on.</p>
102104
<p>See the basic tutorial or the <code class="code docutils literal notranslate"><span class="pre">examples</span></code> folder for examples of writing wf_creator functions.</p>
103105
</div>
104106
<div class="section" id="dimensions">

0 commit comments

Comments
 (0)