Skip to content

docs: name what tests, parity rows and pin scripts hold - #41

Merged
Paullo9 merged 1 commit into
mainfrom
issue-40-prose
Oct 31, 2026
Merged

Paullo9 merged 1 commit into
mainfrom
issue-40-prose

Conversation

@Paullo9

@Paullo9 Paullo9 commented Oct 30, 2026

Copy link
Copy Markdown
Contributor

Requested by Paul · project thread

Part of #40

This PR changes names and comments only. No test meaning changes and no fixture bytes change.

Done here

  • FastDetectionTests: Slice2 is now StructureFactorPins, and slice2Presets is now scatteringPresets.
  • ConventionalSymmetryTests: the test is renamed to testConventionalFalseIsThePlainDetectionAndConventionalFilesAreUnchanged. A comment explains the source == "slice-1" filter: it is the label the conventional-cell pins give the CIF fixture structures. The string itself is fixture data, so it stays.
  • docs/parity.md: P12, P13 and the py4DSTEM note now name the fixtures and the ring rule rather than the session.
  • tools/pins: the first docstring line of seven scripts now names the module it pins.

Left open on #40

  • CIF headers: nine CIF headers read "slice-1 Gate B refuter". The CIFs are sha256-locked in pymatgen-cells-pins.json and numpy-structure-factor-pins.json, so changing a header is a fixture move. It needs its own commit, regenerated pins and a CHANGELOG line.
  • tools/pins comments: the rest of the "slice N" comments in the scripts and READMEs. String literals that are written into fixtures ("source": "slice-1", "purpose", "families") wait for a regeneration.

Test evidence

swift test -c release -j 1 --skip DiffractoKitParityTests --filter "FastDetectionTests|ConventionalSymmetryTests": 13 tests in 2 suites passed. CI runs the full unit gate.

🤖 Generated with Claude Code

…k session made them

FastDetectionTests: the decoder Slice2 is now StructureFactorPins and
slice2Presets is now scatteringPresets. ConventionalSymmetryTests: the test
testConventionalFalseIsSliceOnesDetection... is now
testConventionalFalseIsThePlainDetectionAndConventionalFilesAreUnchanged, and
a comment says the source == "slice-1" filter is the label the conventional
cell pins give the CIF fixture structures. The filter string is fixture data
and stays. docs/parity.md P12, P13 and the py4DSTEM note name the fixtures
and the ring rule, not the session. The first docstring line of seven
tools/pins scripts names the module it pins.

No test meaning and no fixture byte changes. FastDetectionTests and
ConventionalSymmetryTests pass (13 tests).

Done: part of #40. Next: the CIF headers (a fixture move, pins regenerated) and the remaining tools/pins comments.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@Paullo9 Paullo9 self-assigned this Oct 30, 2026
@Paullo9
Paullo9 merged commit 85ac94d into main Oct 31, 2026
6 checks passed
@Paullo9
Paullo9 deleted the issue-40-prose branch October 31, 2026 09:34
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