add newsfragment and fix docs

richardsheridan · Oct 20, 2024 · 483662f · 483662f
1 parent bd1649e
commit 483662f
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 5 deletions.
diff --git a/docs/source/history.rst b/docs/source/history.rst
@@ -45,7 +45,7 @@ trio-parallel 1.2.0 (2022-10-29)
 Features
 ~~~~~~~~
 
-- The behavior of the default context is now fully configurable, superseding `atexit_shutdown_grace_period` (`#328 <https://github.com/richardsheridan/trio-parallel/issues/328>`__)
+- The behavior of the default context is now fully configurable, superseding ``atexit_shutdown_grace_period`` (`#328 <https://github.com/richardsheridan/trio-parallel/issues/328>`__)
 
 
 Bugfixes
@@ -131,7 +131,7 @@ Features
 
 - Added configuration options for the grace periods permitted to worker caches upon
   shutdown. This includes a new keyword argument for :func:`open_worker_context` and
-  a new top level function :func:`atexit_shutdown_grace_period`. (`#108 <https://github.com/richardsheridan/trio-parallel/issues/108>`__)
+  a new top level function ``atexit_shutdown_grace_period``. (`#108 <https://github.com/richardsheridan/trio-parallel/issues/108>`__)
 - :func:`open_worker_context` gained a new argument, ``init``, and ``retire`` is no longer
   called before the first job in the worker. (`#110 <https://github.com/richardsheridan/trio-parallel/issues/110>`__)
 

diff --git a/docs/source/reference.rst b/docs/source/reference.rst
@@ -158,8 +158,6 @@ Internal Esoterica
 
 You probably won't use these... but create an issue if you do and need help!
 
-.. autofunction:: atexit_shutdown_grace_period
-
 .. autofunction:: default_context_statistics
 
 .. _cloudpickle: https://github.com/cloudpipe/cloudpickle

diff --git a/newsfragments/435.removal.rst b/newsfragments/435.removal.rst
@@ -0,0 +1 @@
+Removed deprecated ``atexit_shutdown_grace_period``. Use `configure_default_context` to configure the default context shutdown grace period.
diff --git a/trio_parallel/_abc.py b/trio_parallel/_abc.py
@@ -19,7 +19,7 @@ class BrokenWorkerError(RuntimeError):
     failure of either ``trio-parallel`` or the code that was executing in the worker.
     Some example failures may include segfaults, being killed by an external signal,
     or failing to cleanly shut down within a specified ``grace_period``. (See
-    :func:`atexit_shutdown_grace_period` and :func:`open_worker_context`.)
+    :func:`configure_default_context` and :func:`open_worker_context`.)
     """
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Removed deprecated ``atexit_shutdown_grace_period``. Use `configure_default_context` to configure the default context shutdown grace period.