Skip to content

Document that cached results ignore changes to neighboring files - #115

Merged
yarikoptic merged 1 commit into
masterfrom
claude/inspiring-planck-doh0tc
Oct 5, 2026
Merged

yarikoptic merged 1 commit into
masterfrom
claude/inspiring-planck-doh0tc

Conversation

@CodyCBakerPhD

Copy link
Copy Markdown
Contributor

Closes #114.

Documentation only, no behavior change:

  • docs/design/git-annex-content.md: new section "Other files the function reads". It says that only the first argument is fingerprinted, in stat() and custom modes alike, so a change to a sidecar (e.g. sub-01_bold.json next to sub-01_bold.nii.gz) does not invalidate the cache. It describes two workarounds: fold the neighbors' fingerprints into a custom fingerprint, or pass something identifying their content as extra arguments. The pair_with_path paragraph now says pairing is needed for neighbor-dependent results but is not sufficient.
  • memoize_path docstring: a short note on the same limitation and the workarounds.
  • annex_key_fingerprint docstring (pair_with_path): a note that either way, only the file itself is fingerprinted.

🤖 Generated with Claude Code

https://claude.ai/code/session_014CXyw6SCZnT8aLws6zZ8RE


Generated by Claude Code

Changes to other files the function reads (e.g., BIDS sidecars) do not
invalidate cached results, in stat() mode and with a custom fingerprint
alike; pair_with_path keeps results separate per location but does not
make them depend on neighbors.  Closes #114.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_014CXyw6SCZnT8aLws6zZ8RE
@codecov

codecov Bot commented Oct 1, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.95%. Comparing base (5d90e68) to head (738a24d).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #115   +/-   ##
=======================================
  Coverage   94.95%   94.95%           
=======================================
  Files           6        6           
  Lines         813      813           
  Branches       54       54           
=======================================
  Hits          772      772           
  Misses         25       25           
  Partials       16       16           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@CodyCBakerPhD CodyCBakerPhD self-assigned this Oct 4, 2026
@CodyCBakerPhD
CodyCBakerPhD marked this pull request as ready for review October 4, 2026 18:28
@yarikoptic yarikoptic added the documentation Changes only affect the documentation label Oct 5, 2026
@yarikoptic
yarikoptic merged commit ab99f49 into master Oct 5, 2026
48 checks passed
@yarikoptic
yarikoptic deleted the claude/inspiring-planck-doh0tc branch October 5, 2026 15:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Changes only affect the documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document that cached results are not invalidated by changes to neighboring files (e.g. BIDS sidecars)

3 participants