DOC: State final-state behavior in V&V deliverables - #1725
Merged
imikejackson merged 2 commits intoAug 21, 2026
Conversation
* Replace development-process framing throughout the V&V reports, deviation files, and provenance sidecars with statements of the shipped behavior. The deliverables now describe what the code does and how it differs from DREAM3D 6.5.171, rather than which internal V&V cycle, pass, or PR resolved a given defect. * Rename two provenance sidecars to match their filter names: read_ang_test.md -> ReadAngDataFilter.md and 6_6_read_ctf_data_2.md -> ReadCtfDataFilter.md. No deviation findings, measured values, or test references are changed. Pre-fix/post-fix comparisons are retained where they establish that a regression test is load-bearing. Signed-off-by: Michael Jackson <mike.jackson@bluequartz.net>
* Replace vague wording such as "earlier SIMPLNX releases", "affected releases", and "a build predating this PR" with the actual DREAM3D-NX release versions a reader can check their install against. * Every deviation entry touched here was resolved after 7.4.1 (2026-03-23), so no released version carries the fix. Entries now say so explicitly rather than implying an upgrade is available. * Narrow the window where the introducing change is known: the CAxisSegmentFeatures first-seed defect (PR BlueQuartzSoftware#1466, 2025-11-14) and the ComputeNeighborhoods regression (PR BlueQuartzSoftware#1485, 2026-01-08) each affect 7.4.1 only, since 7.4.0 (2025-10-27) predates both. * Add docs/dream3d_nx_release_dates.md as the version-to-date reference these entries cite. Signed-off-by: Michael Jackson <mike.jackson@bluequartz.net>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The V&V deliverables were describing our own development history — which cycle, pass, or PR
resolved a given defect — rather than the state of the shipped code. A V&V report should say what
the code does today and how that differs from DREAM3D 6.5.171, if at all.
Commit 1 — state final-state behavior
sidecars in
OrientationAnalysis,SimplnxCore, andITKImageProcessing. Phrases such as"fixed during this V&V cycle", "fixed this pass", and "fixed by this PR" are restated as the
resolved condition.
Algorithm Relationshiprows from "Port with bug fix" to "Port with oneinherited bug corrected", which is what those entries actually document — a legacy 6.5.171
defect corrected on the SIMPLNX side, not a SIMPLNX defect.
the rest of the directory:
read_ang_test.mdtoReadAngDataFilter.md, and6_6_read_ctf_data_2.mdtoReadCtfDataFilter.md.Pre-fix/post-fix comparisons are deliberately retained wherever they establish that a regression
test is load-bearing — those describe code states, not our workflow, and removing them would
weaken the coverage argument.
Commit 2 — name the affected releases
Deviation entries told users they were on an "earlier SIMPLNX release" without saying which. Those
now name actual DREAM3D-NX versions:
version carries the fix. The entries say so explicitly instead of implying an upgrade is
available.
first-seed defect (PR BUG: Fixes issue when segmenting features with a +1 feature count #1466, 2025-11-14) and the ComputeNeighborhoods regression (PR BUG: New implementation for ComputeNeighborhoods filter #1485,
2026-01-08) each affect 7.4.1 only, since 7.4.0 (2025-10-27) predates both.
docs/dream3d_nx_release_dates.mdas the version-to-date reference these entries cite.Notes
No deviation findings, measured values, deviation IDs, or test references are changed anywhere in
this PR.
GroupMicroTextureRegionsFilteris deliberately excluded; its V&V documents are rewritten in theopen Group MicroTexture Regions PR and would conflict here.
Test Plan
docs/dream3d_nx_release_dates.mdand the merge datesof the introducing and resolving PRs