Skip to content

Update the external libraries and refresh the documentation - #19

Merged
Skorinn merged 4 commits into
masterfrom
integration
Sep 7, 2026
Merged

Skorinn merged 4 commits into
masterfrom
integration

Conversation

@Skorinn

@Skorinn Skorinn commented Sep 7, 2026

Copy link
Copy Markdown
Owner

Takes the two external libraries from their published releases, brings their documentation with them, and brings the two documentation files in this repository back in line with the code.

The external libraries

Library Was Now
DeviceInterfaces 1.0.0.0 1.1.0.0, from its v1.1.0 release
CommonControls 1.0.1.0, built locally 1.0.0.0, from its v1.0.0 release

CommonControls moves down a patch version, which is worth explaining. Its newest release is still v1.0.0, while what was committed here was a 1.0.1 build that is not published anywhere. Loading both and reading out their public members gives the same 30 in each, so nothing is given up by taking the released one, and it is a build that can be fetched again rather than one that only ever existed on one machine. The reference in the project file follows it down to 1.0.0.0.

If you would rather wait for a 1.0.1 release and keep the local build until then, say so and this part can come back out.

Documentation for the libraries

The XML documentation each release ships with is committed beside its library, so their members describe themselves while writing code against them: 16 documented members for CommonControls, 7 for DeviceInterfaces. MSBuild finds these on its own because they sit next to the assemblies, and copies them to the output. No project change is needed for it.

The release workflow already leaves documentation out of what it packages, which stays right, as none of it is needed to run anything.

The documentation in this repository

CLAUDE.md was written before the last four merges and had drifted away from the code:

  • It said the test project copies the native library into its output. That was the state of things when the application could not load it at all. Both managed projects copy it now.
  • It said the statistics are recomputed for every point. That holds while recording but not while loading, where they are worked out once per batch, which is what stops a large file taking time that grows with the square of its size.
  • Its account of preparing a file for appending covered two of the three shapes that are handled, and described the whole file being rewritten, which is no longer how it works. Recovering a file left unfinished was not mentioned at all.
  • Nothing about the licence, the release workflow, or that the unit tests do not build the form's event wiring, which is why the crash on opening a session file went unseen by them.

README.md now says where the two libraries come from and that they are MIT, rather than describing them only as binaries with no source here.

Verification

With the libraries in place: the solution builds clean, the 207 unit tests pass, and the application was driven through recording, pausing, stopping, clearing, loading, appending, the analysis comparison and recovering an interrupted session. 38 checks and 13 checks, nothing failing.

One of those runs failed twice on the status message before this went in, and it was worth chasing rather than putting down to flakiness. The application was behaving: the device scan now takes nine to twelve seconds where it used to finish inside nine, and the status settles afterwards. The fault was a fixed wait in the test, which now waits for the application to become idle instead.

🤖 Generated with Claude Code

https://claude.ai/code/session_0153VVkWg7DQmdaNLcvtY37w

Skorinn and others added 4 commits September 5, 2026 12:04
The README described CommonControls.dll and DeviceInterfaces.dll only as
binaries with no source here, which left a reader with no way of finding out
what they are or what they may be used for. They are built from repositories
of their own, which the README now points at.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0153VVkWg7DQmdaNLcvtY37w
They are, and saying so is more use to a reader than pointing them elsewhere
to find out. An earlier check of those repositories reported no licence, which
was a fault in how the check read the answer rather than anything about the
repositories.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0153VVkWg7DQmdaNLcvtY37w
It was written before the last four merges and had drifted:

- It said the test project copies the native library into its output, which
  was the state of things when the application could not load it at all. Both
  managed projects copy it now, and the reason is worth stating.
- It said the statistics are recomputed for every point. That holds while
  recording but not while loading, where they are worked out once per batch,
  which is what stops a large file taking time that grows with its size
  squared. The cost of the recording path and the reason rolling sums were not
  used are recorded as well.
- Its description of preparing a file for appending covered two of the three
  shapes that are handled and described the whole file as being rewritten,
  which is no longer how it works. Recovering a file that was left unfinished
  was not mentioned at all.
- Nothing about the licence, the release workflow, or that the unit tests do
  not build the form's event wiring, which is why the crash on loading a file
  went unseen by them.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0153VVkWg7DQmdaNLcvtY37w
…along

DeviceInterfaces moves from 1.0.0 to the 1.1.0 release. CommonControls is
taken from its 1.0.0 release, replacing a 1.0.1 build that was not published
anywhere. Reading the public members out of both of those shows the same 30,
so nothing is given up by using the released one, and it is a build that can
be obtained again rather than one that only existed here.

The documentation each release ships with is committed beside its library, so
their members describe themselves while writing code against them. MSBuild
picks these up on its own and copies them to the output; the release workflow
already leaves documentation out of what it packages, as it is not needed to
run anything.

The reference in the project file follows CommonControls down to 1.0.0.

Checked with the libraries in place: the solution builds clean, the 207 unit
tests pass, and the application was driven through recording, pausing,
stopping, clearing, loading, appending, the analysis comparison and recovering
an interrupted session, at 38 and 13 checks with nothing failing.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0153VVkWg7DQmdaNLcvtY37w
Copilot AI lite review requested due to automatic review settings September 7, 2026 20:05

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Needs a closer look

It updates external binary dependencies whose internal changes cannot be meaningfully reviewed from the provided diffs, so final human verification is warranted.

Pull request overview

Updates the two checked-in external library dependencies to their published releases and refreshes repository documentation so the build, architecture notes, and third-party attribution reflect the current codebase.

Changes:

  • Updated the CommonControls assembly reference metadata to align with the published release version.
  • Added XML documentation files alongside the external assemblies to enable IntelliSense/member docs during development.
  • Refreshed README.md and CLAUDE.md to reflect the current dependency provenance and current build/architecture behavior.
File summaries
File Description
README.md Updates third-party section to document the origin and license of the external binary dependencies.
RandomNumberGenerator.csproj Adjusts the CommonControls reference version metadata to match the updated external assembly.
Externals/DeviceInterfaces.xml Adds XML documentation shipped with the external DeviceInterfaces release.
Externals/CommonControls.xml Adds XML documentation shipped with the external CommonControls release.
CLAUDE.md Refreshes build/architecture documentation to match current behavior (native DLL copying, file-append semantics, release notes).
Review details

Files not reviewed (2)

  • Externals/CommonControls.xml: Generated file
  • Externals/DeviceInterfaces.xml: Generated file
  • Files reviewed: 3/7 changed files
  • Comments generated: 0
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@Skorinn Skorinn self-assigned this Sep 7, 2026
@Skorinn
Skorinn merged commit 86d7b47 into master Sep 7, 2026
1 check passed
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.

2 participants