Repository navigation
fix: reader notes state what is known instead of unvalidated - #74
Merged
Merged
Conversation
Apps show the reader notes verbatim, so each note now states the plain fact and names where in the file the value is stored: - TIFFVeloxCalibration: "scale as Velox stores it (BinaryResult/PixelSize), not checked against a calibration standard". - AcquisitionMetadata (generic): "no published reader reads this field; read as the file stores it". Each format now attaches its own wording: DM image tags, Velox metadata, the FEI extended header at the offset mrcfile declares, the Velox XML or the FEI header of a TIFF. - Velox detector: "read from BinaryResult.Detector; RosettaSciIO names some detectors from another field". - MRC camera length: "shown as stored; the instrument mode is not checked, as no published reader decodes it". The public names stay (unvalidatedNote, veloxUnvalidated); the new names noPublishedReaderNote, storedScaleNote and veloxStoredScale are aliases of the same strings. Only note text changes; no value moves. tools/acq-metadata/generate.py applies the same wording to the pinned app output, so a regeneration reproduces the pins. Done: notes reworded, tests pin the new texts. Next: consumers re-pin their snapshot tests when they update. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Reason: the readers now word their notes as plain facts instead of "unvalidated" (previous commit). The six pins files hold the pinned app output, notes included; only the note strings (and the TIFF source line that embeds the Velox scale note) change. No number, key or value moves. tools/acq-metadata/generate.py now applies the same wording, and a check of its mapping against the old pins reproduces these files exactly. Tests/Fixtures/README.md: the size column of the six files. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
Requested by Paul · project thread
No app or export should show "unvalidated" wording. Each reader note now gives the plain fact and names where in the file the value is stored.
TIFFVeloxCalibration.unvalidatedNote(=TIFFAppImage.Note.veloxUnvalidated)AcquisitionMetadata.unvalidatedNote(generic)Call sites that used the generic note now attach their own format's wording.
API. No symbol was removed or renamed, so consumers compile unchanged. There are three new aliases for the same strings:
AcquisitionMetadata.noPublishedReaderNote,TIFFVeloxCalibration.storedScaleNoteandTIFFAppImage.Note.veloxStoredScale.Consumers display these notes verbatim. On update, their own snapshot or literal tests of these notes may need re-pinning.
Fixtures. The six pins files were re-recorded in their own commit. Only the note strings changed, plus the TIFF source line that contains the scale note. No number moved.
tools/acq-metadata/generate.pynow applies the same wording to the pinned app output, and a check of its mapping against the old pins reproduces the new files exactly.Tests. The tests pin the new texts and check that the aliases equal the old names and that no note contains "unvalidated". Gate results are below.
tools/test.sh --skip FormatoKitParityTests: green; 444 tests and no build warnings.--filter FormatoKitParityTests): green; 18 tests, 5 skipped because owner data is absent.--strictand SwiftFormat--lint(repo configs): clean.tools/fixture-index/index.py --check: current.docs/parity.mdstill describes these fields as labelled "unvalidated" in prose. It is left for a follow-up because two open PRs already edit that file.🤖 Generated with Claude Code