From c29d6f78834e988ad8b76da102527333381033b4 Mon Sep 17 00:00:00 2001 From: Tim Smith Date: Sat, 29 Aug 2026 19:36:15 -0700 Subject: [PATCH] docs: document the status_report keyword arguments status_report was the only method left in the driver whose parameters had no @param tags. Document all four keywords and give the existing @return a description, so the YARD tag coverage is complete alongside the 100% object coverage yard stats already reports. Comments only; no behaviour change. Signed-off-by: Tim Smith --- lib/kitchen/driver/hyperv.rb | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/lib/kitchen/driver/hyperv.rb b/lib/kitchen/driver/hyperv.rb index 88a3ee3..e38e122 100644 --- a/lib/kitchen/driver/hyperv.rb +++ b/lib/kitchen/driver/hyperv.rb @@ -199,7 +199,14 @@ def doctor(state) # Build the status hash Test Kitchen normalizes. # - # @return [Hash] + # @param live [Boolean, nil] whether the virtual machine is running, or + # nil when the driver could not determine it + # @param state [String] the lifecycle state to report: "not_created", + # "running", "stopped", or "unknown" + # @param message [String] human-readable explanation of the state + # @param resource_id [String, nil] the Hyper-V virtual machine id, when + # one is known + # @return [Hash] the status data, stamped with a UTC `checked_at` time # @api private def status_report(live:, state:, message:, resource_id: nil) {