From 29cc5425aaf21287e6f068ec6144c9156c5a15e1 Mon Sep 17 00:00:00 2001 From: David Anthoff Date: Wed, 19 Aug 2026 10:28:54 -0700 Subject: [PATCH] Reattach the TestItemController docstring `const DEFAULT_SHUTDOWN_GRACE_SECONDS` was added between the docstring and the struct it documents, so the docstring attached to the const instead and `TestItemController` ended up with none. `deploy-docs` has been failing on main ever since: no docs found for 'TestItemControllers.TestItemController' in `@docs` block Cannot resolve @ref for md"[`TestItemController`](@ref)" Moving the const above the docstring puts the docstring back next to the struct. Verified by building the docs locally: `makedocs` now renders instead of terminating on :docs_block and :cross_references. --- src/testitemcontroller.jl | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/testitemcontroller.jl b/src/testitemcontroller.jl index 6169959..59dbfef 100644 --- a/src/testitemcontroller.jl +++ b/src/testitemcontroller.jl @@ -1,3 +1,7 @@ +# Shutdown normally completes as soon as every process has reported its termination — a +# few hundred milliseconds. This is the backstop for the case where one never does. +const DEFAULT_SHUTDOWN_GRACE_SECONDS = 30.0 + """ TestItemController(callbacks; error_handler_file=nothing, crash_reporting_pipename=nothing, log_level=:Info) @@ -34,10 +38,6 @@ the reactor event loop, then use [`execute_testrun`](@ref) to submit work. See also [`ControllerCallbacks`](@ref), [`execute_testrun`](@ref), [`shutdown`](@ref), [`wait_for_shutdown`](@ref). """ -# Shutdown normally completes as soon as every process has reported its termination — a -# few hundred milliseconds. This is the backstop for the case where one never does. -const DEFAULT_SHUTDOWN_GRACE_SECONDS = 30.0 - mutable struct TestItemController{CB<:ControllerCallbacks} callbacks::CB