Skip to content

Docs: correct what had fallen behind the code - #91

Merged
jadamcrain merged 1 commit into
mainfrom
docs-accuracy
Oct 15, 2026
Merged

jadamcrain merged 1 commit into
mainfrom
docs-accuracy

Conversation

@jadamcrain

Copy link
Copy Markdown
Member

Corrections from checking every claim in the README, CHANGELOG, docs/manual-testing.md, docs/automation.md and CLAUDE.md against main, and running the CLI commands they quote.

  • CHANGELOG: the upgrade list now says Harness and Harness.writeReport take the revision, and ProcedureResult has a notes field. The link to the automation guide is absolute, since the release notes are copied from this file and a relative link breaks there.
  • Library version: docs/automation.md's dependency example says 0.2.0 (its examples don't compile against 0.1.0), and it says how to use an unreleased build.
  • Building: any full JDK 17 or newer builds it (CI builds with 17 and 21), not only 21.
  • Configuration: -options marks five options as required, not one; four are Device Profile values needed only by the procedures that use them. Only commands that read the configuration check it.
  • 3.1r1's response rules: a response may also ask for confirmation when it reports a broadcast (IIN1.0), and an unsolicited response carries only event data.
  • Sections: 3.1r1 also has section 10 (output control events).
  • Exit code: it's also nonzero when the report couldn't be written.
  • Smaller fixes: the harness connects over TCP or the serial port; DefaultIntegrationPlugin prompts for actions and verifications (its lifecycle methods do nothing); -describe of a section lists its procedures; the 70.5 s waits are named for both revisions; dnp3's CI runs each revision; CLAUDE.md no longer calls 3.1 rev 1 a goal.

@jadamcrain
jadamcrain enabled auto-merge October 15, 2026 20:46
@jadamcrain
jadamcrain added this pull request to the merge queue Oct 15, 2026
Merged via the queue into main with commit 3d029a0 Oct 15, 2026
9 of 10 checks passed
@jadamcrain
jadamcrain deleted the docs-accuracy branch October 15, 2026 20:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant