[trio.from_thread]

Applied `fixup_module_metadata` to `trio.from_thread` and corrected most
Sphinx build warnings.

Author: epellis

docs/source/history.rst

@@ -564,7 +564,7 @@ Upcoming breaking changes with warnings (i.e., stuff that in 0.2.0
 
   * We took the opportunity to refactor ``run_in_trio_thread`` and
     ``await_in_trio_thread`` into the new class
-    :class:`trio.BlockingTrioPortal`
+    ``trio.BlockingTrioPortal``
 
   * The hazmat function ``current_call_soon_thread_and_signal_safe``
     is being replaced by :class:`trio.hazmat.TrioToken`

docs/source/reference-core.rst

@@ -1464,8 +1464,8 @@ for working with real, operating-system level,
 :mod:`threading`\-module-style threads. First, if you're in Trio but
 need to push some blocking I/O into a thread, there's
 :func:`run_sync_in_thread`. And if you're in a thread and need
-to communicate back with Trio, you can use a
-`trio.from_thread`.
+to communicate back with Trio, you can use
+:func:`trio.from_thread.run` and :func:`trio.from_thread.run_sync`.
 
 
 .. _worker-thread-limiting:
@@ -1603,9 +1603,9 @@ Putting blocking I/O into worker threads
 Getting back into the Trio thread from another thread
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-.. autofunction:: from_thread.run
+.. autofunction:: trio.from_thread.run
 
-.. autofunction:: from_thread.run_sync
+.. autofunction:: trio.from_thread.run_sync
 
 This will probably be clearer with an example. Here we demonstrate how
 to spawn a child thread, and then use a :ref:`memory channel

docs/source/reference-hazmat.rst

@@ -339,11 +339,11 @@ These transitions are accomplished using two function decorators:
    function).
 
    An example of where you'd use this is in implementing something
-   like :meth:`trio.from_thread.run`, which uses
+   like :func:`trio.from_thread.run`, which uses
    :meth:`TrioToken.run_sync_soon` to get into the Trio
    thread. :meth:`~TrioToken.run_sync_soon` callbacks are run with
    :exc:`KeyboardInterrupt` protection enabled, and
-   :meth:`~trio.from_thread.run` takes advantage of this to safely set up
+   :func:`trio.from_thread.run` takes advantage of this to safely set up
    the machinery for sending a response back to the original thread, but
    then uses :func:`disable_ki_protection` when entering the
    user-provided function.

trio/__init__.py

@@ -119,7 +119,7 @@
             _BlockingTrioPortal,
             "0.12.0",
             issue=810,
-            instead=("trio.from_thread.run(), trio.from_thread.run_sync()")
+            instead=from_thread,
         ),
 }
 
@@ -134,6 +134,7 @@
 fixup_module_metadata(hazmat.__name__, hazmat.__dict__)
 fixup_module_metadata(socket.__name__, socket.__dict__)
 fixup_module_metadata(abc.__name__, abc.__dict__)
+fixup_module_metadata(from_thread.__name__, from_thread.__dict__)
 fixup_module_metadata(__name__ + ".ssl", _deprecated_ssl_reexports.__dict__)
 fixup_module_metadata(
     __name__ + ".subprocess", _deprecated_subprocess_reexports.__dict__

trio/_threads.py

@@ -369,7 +369,7 @@ def run(afn, *args, trio_token=None):
             already completed.
         Cancelled: if the corresponding call to :func:`trio.run` completes
             while ``afn(*args)`` is running, then ``afn`` is likely to raise
-            :class:`Cancelled`, and this will propagate out into
+            :exc:`trio.Cancelled`, and this will propagate out into
         RuntimeError: if you try calling this from inside the Trio thread,
             which would otherwise cause a deadlock.
         AttributeError: if run()'s thread local storage does not have a token.
@@ -415,7 +415,7 @@ def run_sync(fn, *args, trio_token=None):
             already completed.
         Cancelled: if the corresponding call to `trio.run` completes
             while ``afn(*args)`` is running, then ``afn`` is likely to raise
-            :class:`Cancelled`, and this will propagate out into
+            :exc:`trio.Cancelled`, and this will propagate out into
         RuntimeError: if you try calling this from inside the Trio thread,
             which would otherwise cause a deadlock.
         AttributeError: if run()'s thread local storage does not have a token.