Skip to content

DOC: State final-state behavior in V&V deliverables - #1725

Merged
imikejackson merged 2 commits into
BlueQuartzSoftware:developfrom
imikejackson:topic/vv_updates
Aug 21, 2026
Merged

DOC: State final-state behavior in V&V deliverables#1725
imikejackson merged 2 commits into
BlueQuartzSoftware:developfrom
imikejackson:topic/vv_updates

Conversation

@imikejackson

@imikejackson imikejackson commented Aug 21, 2026

Copy link
Copy Markdown
Contributor

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

  • Replaces development-process framing across 37 V&V reports, deviation files, and provenance
    sidecars in OrientationAnalysis, SimplnxCore, and ITKImageProcessing. Phrases such as
    "fixed during this V&V cycle", "fixed this pass", and "fixed by this PR" are restated as the
    resolved condition.
  • Reclassifies two Algorithm Relationship rows from "Port with bug fix" to "Port with one
    inherited bug corrected", which is what those entries actually document — a legacy 6.5.171
    defect corrected on the SIMPLNX side, not a SIMPLNX defect.
  • Renames two provenance sidecars to match their filter names, following the convention used by
    the rest of the directory: read_ang_test.md to ReadAngDataFilter.md, and
    6_6_read_ctf_data_2.md to ReadCtfDataFilter.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:

Notes

No deviation findings, measured values, deviation IDs, or test references are changed anywhere in
this PR.

GroupMicroTextureRegionsFilter is deliberately excluded; its V&V documents are rewritten in the
open Group MicroTexture Regions PR and would conflict here.

Test Plan

  • Documentation-only change; no source files touched, so no build or test impact
  • Markdown table integrity verified (column counts unchanged on all modified table rows)
  • Renames recorded as pure renames (100% / 99% similarity), no content lost
  • Release windows cross-checked against docs/dream3d_nx_release_dates.md and the merge dates
    of the introducing and resolving PRs

* 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>
@imikejackson
imikejackson merged commit 228c4e9 into BlueQuartzSoftware:develop Aug 21, 2026
6 checks passed
@imikejackson
imikejackson deleted the topic/vv_updates branch August 21, 2026 20:07
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