Skip to content

db0c338's message does not describe its contents #42

Description

@w4ffl35

Commit db0c338 is titled "Fix the plan's cross-tree links, which broke the docs build". It also contains, undescribed:

spikeforge/events/hsd_reader.py | 126 ++++++++++++++++   (the whole native HDF5 reader)
spikeforge/data/dataset_spec.py |   6 ++                 (the native_reader field)
spikeforge/data/datasets.py     |   3 +-                 (SSC routing)
spikeforge/data/event_loader.py |   9 ++-                (loader routing)
plans/hub_expansion_plan.md     |   6 +-                 (the actual docs fix)

It swept up in-flight work that was sitting uncommitted in the tree. The reader's tests were not included and landed separately in 3692d31.

Nothing is wrong with the code; the problem is that the history misdescribes itself. Someone bisecting for the origin of hsd_reader.py would never look in a commit about documentation links, and someone reading db0c338 alone would see an untested 126-line module appear with no rationale.

Resolution: leave the history alone — it is pushed, and rewriting it is worse than the defect. This issue is the follow-up note. Close it once it has been read.

Avoiding a repeat: stage explicit paths rather than git add -A when a shared working tree may hold someone else's in-progress work.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions