From 8eb138b8a7c1c1c31fde64d7c84abf064586c869 Mon Sep 17 00:00:00 2001 From: Tyler Goodlet Date: Thu, 7 Mar 2019 18:28:22 -0500 Subject: [PATCH] Add Windows *gotchas* section Resolves #61 --- README.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.rst b/README.rst index e4ae1f4..7c1c8c6 100644 --- a/README.rst +++ b/README.rst @@ -82,6 +82,16 @@ No PyPi release yet! pip install git+git://github.com/tgoodlet/tractor.git +Windows "gotchas" +***************** +`tractor` uses the stdlib's `multiprocessing` module internally which +*can* have some *gotchas* on Windows, namely the need for calling +`freeze_support()`_ inside the ``__main__`` context. See `#61`_ for the +deats. + +.. _freeze_support(): https://docs.python.org/3/library/multiprocessing.html#multiprocessing.freeze_support +.. _#61: https://github.com/tgoodlet/tractor/pull/61#issuecomment-470053512 + Examples --------