diff options
| -rw-r--r-- | lib/system/channels.nim | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/lib/system/channels.nim b/lib/system/channels.nim index 14d3a3005..057ea2843 100644 --- a/lib/system/channels.nim +++ b/lib/system/channels.nim @@ -7,12 +7,17 @@ # distribution, for details about the copyright. # -## Channel support for threads. **Note**: This is part of the system module. -## Do not import it directly. To activate thread support you need to compile -## with the ``--threads:on`` command line switch. +## Channel support for threads. +## +## **Note**: This is part of the system module. Do not import it directly. +## To activate thread support compile with the ``--threads:on`` command line switch. +## +## **Note:** Channels are designed for the ``Thread`` type. They are unstable when +## used with ``spawn`` ## ## **Note:** The current implementation of message passing does ## not work with cyclic data structures. +## ## **Note:** Channels cannot be passed between threads. Use globals or pass ## them by `ptr`. |