Skip to content

Commit 110a09e

Browse files
committed
📝 Update doc/conf.
1 parent dec6b5a commit 110a09e

2 files changed

Lines changed: 8 additions & 6 deletions

File tree

docs/source/api/utilities.inc

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,12 @@ Timekeeper
2121

2222
.. autoclass:: gama.utilities.generic.timekeeper.TimeKeeper
2323

24-
AsyncExecutor
25-
~~~~~~~~~~~~~
24+
AsyncEvaluator
25+
~~~~~~~~~~~~~~
2626

2727
.. warning::
28-
This component in particular has its own issues and will be replaced.
29-
But I have yet to find a satisfying alternative to 'hacking' the built-in ProcessPoolExecutor.
28+
I'm sure there are better tools out there, but I have yet to find a minimal easy multi-processing tool.
29+
I tried using the built-in ProcessPoolExecutor, but it had short comings such as not being able to cancel
30+
jobs while they were running.
3031
31-
.. autoclass:: gama.utilities.generic.async_executor.AsyncExecutor
32+
.. autoclass:: gama.utilities.generic.async_evaluator.AsyncEvaluator

docs/source/conf.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@
1919
# -- Adding the module to document ----------------------------------------
2020
import os
2121
import sys
22-
sys.path.append(os.path.abspath('../gama'))
22+
23+
sys.path.insert(0, os.path.abspath('../..'))
2324

2425
# -- Copying Example files over -------------------------------------------
2526
import shutil

0 commit comments

Comments
 (0)