From 50de028356d007a79c66072db19fc57d1855e65d Mon Sep 17 00:00:00 2001 From: Fredrik Ahlgren Date: Wed, 7 Oct 2026 14:12:54 +0200 Subject: [PATCH] docs: let gap_satisfied cover the fleet search too Energyplan 0.5.0 returns gap_satisfied from its fleet search when the search stops on mip_rel_gap and the published gap still meets it. The contract said only the library could claim it. Name the search instead. Paired with the byte-identical copy in srcfl/energyplan. Co-Authored-By: Claude Opus 5.5 --- docs/energyplan-contract.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/energyplan-contract.md b/docs/energyplan-contract.md index 69b80497b..7de8b5ef9 100644 --- a/docs/energyplan-contract.md +++ b/docs/energyplan-contract.md @@ -147,7 +147,7 @@ replay with the same goals, measurements and initial/final stored energy. | Status or error | Meaning | |---|---| | `optimal` | A valid global cost interval closed within numerical tolerances for the stated model and objectives | -| `gap_satisfied` | The library met its configured gap target; a nonzero gap remains | +| `gap_satisfied` | The search met its configured gap target; a nonzero gap remains | | `feasible` | A validated candidate exists; optimality may be unproved and the bound unknown | | `infeasible` | The modeled physical problem has no feasible plan; a failed heuristic or expired budget cannot establish this | | `deadline_exceeded` | A resource limit left no usable result; it says nothing about physical feasibility |