Skip to content

docs: last README, CITATION and fixture provenance gaps - #56

Merged
Paullo9 merged 2 commits into
mainfrom
issue-17-remainder
Oct 31, 2026
Merged

Paullo9 merged 2 commits into
mainfrom
issue-17-remainder

Conversation

@Paullo9

@Paullo9 Paullo9 commented Oct 31, 2026

Copy link
Copy Markdown
Contributor

Requested by Paul · project thread

Fixes #17

#28 and #39 did most of this issue. This PR closes the gaps left on main:

  • NOTICE provenance, last two lines: the Cu3Au-occ and Weak-cut presets in tools/pins/structure-factors/pins.py still cited macTEM a58c84c, and the script writes that text into the note of two structures in numpy-structure-factor-pins.json. Both now say "macTEM before v1.0.0 (history squashed)", as NOTICE does. A fixture move of two note strings only: no number changes, and no other pin hash-locks this file. No other file cites a58c84c or 9482831.
  • Fixture list: Tests/Fixtures/README.md lists orix-orientation-api-pins.json (added by feat: Orientation from Euler angles, dot, dotOuter and distanceMatrix #44) and counts 54 tracked files, which is what git ls-files gives. The stray .keep is already gone.
  • CITATION.cff: date-released was still 0.10.0's date (2026-10-22) under version: 0.11.0; it is now 2026-10-30, the 0.11.0 release day. From the next release on, release-please writes it (ci: release-please dates CITATION.cff in the Release PR #45).

Bullets already done on main or settled elsewhere:

Left for Paul: the Swift Package Index listing (submitting the package to swiftpackageindex.com). The README badge follows once the package is listed.

Test evidence: swift test -c release --skip DiffractoKitParityTests green locally (0 failures). CI pending.

🤖 Generated with Claude Code

The two structure-factor presets ported from macTEM cited commit a58c84c, which is not in the public macTEM history. The pin script and the note strings it writes into numpy-structure-factor-pins.json now say "macTEM before v1.0.0 (history squashed)", as NOTICE does. Only the two note strings move; no number changes and the file is not hash-locked by another pin.

Tests/Fixtures/README.md lists orix-orientation-api-pins.json and counts 54 files. CITATION.cff dates 0.11.0 with its release day, 2026-10-30.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@Paullo9 Paullo9 self-assigned this Oct 31, 2026
@Paullo9
Paullo9 merged commit be1a395 into main Oct 31, 2026
6 checks passed
@Paullo9
Paullo9 deleted the issue-17-remainder branch October 31, 2026 19:45
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.

README, CHANGELOG, CITATION, NOTICE and fixture licences

1 participant