Skip to content

Commit ba16a4b

Browse files
dmealingclaude
andcommitted
site: the requirements sample was missing title and description
Same defect as the article draft: the YAML block presented as a real ledger entry had `title` and `description` stripped out -- the two fields that are already the de-facto standard across every ledger measured (title 85-100%, description 15-97%). Restored both, and the explanation list now says why there are three text fields instead of implying `statement` is the only one. Still unpushed, so nothing wrong ever reached the live site. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_015WgNA6uDN9qxu2nA471rAq
1 parent d2f51e5 commit ba16a4b

1 file changed

Lines changed: 8 additions & 1 deletion

File tree

www/requirements.html

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,16 +155,23 @@ <h2>So give it one</h2>
155155

156156
<pre><code><span class="tok-cmt">- requirement.functional:</span>
157157
<span class="tok-key">name</span>: <span class="tok-val">botCanBeRetiredWithoutErasingItsResults</span>
158+
<span class="tok-key">title</span>: <span class="tok-val">Bot retirement preserves results</span>
158159
<span class="tok-key">level</span>: <span class="tok-val">5</span>
159160
<span class="tok-key">status</span>: <span class="tok-val">live</span>
160161
<span class="tok-key">statement</span>: <span class="tok-val">"A bot's participation is switched by its own status, so it
161162
can be withdrawn while the hands it played stay on the record."</span>
162163
<span class="tok-key">counterexample</span>: <span class="tok-val">"A misbehaving bot that can only be stopped by deleting
163164
it, taking every hand it played with it."</span>
165+
<span class="tok-key">description</span>: <span class="tok-val">&gt;-</span>
166+
<span class="tok-val">A status on the bot rather than a deletion, so withdrawing a
167+
misbehaving entrant leaves every hand it played on the record.</span>
164168
<span class="tok-key">implementedBy</span>: [<span class="tok-val">arena::Bot.status</span>]</code></pre>
165169

166170
<ul>
167-
<li><strong>The statement</strong> says what the capability is, in a sentence.</li>
171+
<li><strong><code>title</code></strong> is the short label, <strong><code>statement</code></strong>
172+
is what the capability is in a sentence, and <strong><code>description</code></strong> is
173+
the longer form. Three fields because an index, a doc page and a test each want a
174+
different one.</li>
168175
<li><strong>The counterexample</strong> says what a violation looks like. That single line
169176
is what an assertion gets written against.</li>
170177
<li><strong><code>implementedBy</code></strong> names the <em>member</em> — the real field

0 commit comments

Comments
 (0)