Revised the Implementation examples to comply with iso - #142
Revised the Implementation examples to comply with iso#142seanmcilroy29 wants to merge 9 commits into
Conversation
Signed-off-by: Sean Mcilroy <smcilroy@linuxfoundation.org>
Signed-off-by: Sean Mcilroy <smcilroy@linuxfoundation.org>
SCI for AI ratified by the SC
Signed-off-by: gosia-f <gosia@greensoftware.foundation>
Signed-off-by: gosia-f <gosia@greensoftware.foundation>
Responded to comments to add a call out to include pre, mid and post training. Also added in about including test runs. Signed-off-by: j-turnbull <jonturnbull@google.com>
Update SPEC.md
Revised the Implementation examples to comply with iso Signed-off-by: Sean Mcilroy <smcilroy@linuxfoundation.org>
Review: Implementation examples (PR #142)Thanks for aligning §9 with ISO-style formatting. Since this is a spec repo (not code), I focused feedback on numerical correctness, Markdown rendering, and scope. Per What this fixes (nice catches)This PR corrects several pre-existing numerical inconsistencies, and the new figures now reconcile internally:
Rendering bug — EXAMPLE lines glued to the numbered listIn §9.1.1 and §9.1.2, the In Markdown this is a lazy continuation, so Trailing whitespace on blank linesThe reformat converted every blank separator line to a line containing a single space. This is pervasive across §9 and will trip Markdown linters / show up as diff noise. Please strip trailing whitespace so blank lines are truly empty. Missing blank line before a heading
Scope: unrelated file added
Minor / optional
Nothing blocking beyond the |
Signed-off-by: Sean Mcilroy <smcilroy@linuxfoundation.org>
Review: PR #142 — Revised the Implementation examples to comply with ISOThanks for this. I checked the changed sections against ✅ Verified correct (and two bugs fixed)I recomputed all four worked examples:
Two pre-existing errors are corrected here, and they are worth calling out in the PR description so reviewers on the weekly call notice them:
Also good: §9.1.2 adding 🔴 Rendering regression (unrelated to §9)
> **Explanation**:
> - **Gross values** refer to total quantities...A blank line terminates a blockquote in CommonMark, so this splits one blockquote into two adjacent ones with a visible gap. Either revert the line, or use a bare > **Explanation**:
>
> - **Gross values** refer to total quantities...This is in §8.2.2, outside the PR's stated scope — probably an accidental edit. 🟠 Scope: two unrelated files in an "Implementation examples" PR
On
On * [Navveen Balani (Accenture)](https://github.com/navveenb)
* [Henry Richardson (WattTime)](https://github.com/Henry-WattTime)🟡 ISO alignment is partialThe
If §§1–8 are being handled by the sibling PRs (#137–#141), a note in the description saying so would help; otherwise merging this alone leaves the spec in a visibly mixed state.
Relatedly — collapsing the bullet breakdowns into single run-on sentences costs real scannability:
ISO/IEC Directives Part 2 permit lists inside examples, so the inputs could stay as bullets with only the label changing. Worth a decision on the call — this one is a judgement call, not a rule. 🟡 Content consistency
Unit presentation differs between the two examples. §9.1.3 reports Terminology (pre-existing, low priority): the boundary lists say Asymmetry: §9.1 subsections have a 🟡 WhitespaceRoughly 30 lines in §9 that read as blank in the diff actually contain a single space ( 💡 CI suggestion (optional, out of scope)
SummaryNothing here blocks on substance — the numbers are right, and this PR quietly fixes a 1000× reporting error plus a self-contradictory value. Recommended before merge:
Items 4–5 and the ISO-consistency notes could reasonably be follow-ups if the group wants this section landed now. No security concerns — documentation-only changes, no executable content. |
Revised the Implementation examples to comply with iso