Skip to content

Comments

DOC: Fix filter documentation and documentation related code bugs#1547

Open
imikejackson wants to merge 4 commits intoBlueQuartzSoftware:developfrom
imikejackson:topic/update_documentation
Open

DOC: Fix filter documentation and documentation related code bugs#1547
imikejackson wants to merge 4 commits intoBlueQuartzSoftware:developfrom
imikejackson:topic/update_documentation

Conversation

@imikejackson
Copy link
Contributor

Summary

  • Audit all ~152 SimplnxCore and ~54 OrientationAnalysis filter docs against their C++ implementations
  • Fix 6 C++ code bugs in defaultTags() (missing commas causing string concatenation, #-prefixed tags, typo "Phae""Phase")
  • Fix 25 doc title mismatches vs humanName()
  • Fix 27+ doc Group/Subgroup mismatches vs defaultTags() (e.g., "Crystallographic""Crystallography", wrong group names)
  • Fix 11 major and 8 medium description inaccuracies in SimplnxCore docs
  • Fix 4 data type errors in SimplnxCore docs
  • Remove 2 orphan doc files (UncertainRegularGridSampleSurfaceMesh.md, GeneratePoleFigureFilter.md)

78 files changed across 2 commits (6 C++ source files, 70 markdown doc files, TODO.md, SUMMARY.md).

Test plan

  • Full ninja build succeeds with no errors
  • All SimplnxCore unit tests pass for modified C++ files (CombineAttributeArrays, CreateImageGeometry, ReadVolumeGraphicsFile, ReadBinaryCTNorthstar)
  • All 138 OrientationAnalysis unit tests pass (0 failures)
  • Verified each doc fix against humanName() and defaultTags() in the corresponding C++ source
  • Verified orphan docs have no references elsewhere in the codebase before deletion

🤖 Generated with Claude Code

@imikejackson imikejackson changed the title DOC/COMP: Fix SimplnxCore and OrientationAnalysis filter documentation and code bugs DOC: Fix Plugin filter documentation and documentation related code bugs Feb 24, 2026
@imikejackson imikejackson changed the title DOC: Fix Plugin filter documentation and documentation related code bugs DOC: Fix filter documentation and documentation related code bugs Feb 25, 2026
imikejackson and others added 4 commits February 24, 2026 22:53
Audit all ~152 SimplnxCore filter docs against C++ implementations.
Fix 4 code bugs (missing commas in defaultTags() causing string
concatenation, inconsistent # tag prefixes), 17 doc title mismatches
vs humanName(), 11 major description inaccuracies, 8 medium severity
doc issues, 4 data type range errors, and remove 1 orphan duplicate
doc file.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…s() bugs

Audit all 54 OrientationAnalysis filter docs against C++ implementations.
Fix 2 code bugs (#-prefixed tags in AlignSectionsMutualInformationFilter,
"Phae" typo in CreateEnsembleInfoFilter), 8 doc title mismatches vs
humanName(), 27 doc Group/Subgroup mismatches vs defaultTags(), and
remove 1 orphan doc file (GeneratePoleFigureFilter.md).

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Audit all 88 ITKImageProcessing filter docs against C++ implementations.
Fix 5 doc title mismatches (extraneous parenthetical suffixes), 3
description inaccuracies (wrong filter operations from copy-paste errors),
2 Group/Subgroup mismatches, and 1 doc format/footer inconsistency.
Note: ITKBoundedReciprocalImageFIlter.cpp filename typo not renamed
(CMake risk); flagged for manual attention.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@imikejackson imikejackson force-pushed the topic/update_documentation branch from d1809c0 to fd08229 Compare February 25, 2026 03:53
@imikejackson imikejackson enabled auto-merge (squash) February 25, 2026 03:55
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