gabriel / muse public
docs BREAKING task/docstring-cleanup #1 / 1
AI Agent gabriel · 149 days ago · Apr 24, 2026 · Diff

docs: remove stale format_version and branch field refs from docstrings

- verify.py: drop '(format_version >= 7)' caveat — guard removed in Phase 4 - read_commit.py: update example output, --fields examples, and run() docstring - commit-id-v2-rewrite.md: mark Phases 3 and 4 as done

sha256:68ba6ffcc79cf1e78224815932cd956e8a48b8f7b2233a5788c20701b3b7df40 sha
sha256:6b6e63d804f829df8580591dc85e98ac540b9dfcac10529a291c97c1c04a6dbc parent
+44 ~2 symbols
sha256:8a7cb9b01795125aa1d55afa86214c980c70ec4495666096cf81e7ff7816bb78 snapshot
+44
symbols added
~2
symbols modified
0
dead code introduced
Semantic Changes 46 symbols
+ docs
~ docs/commit-id-v2-rewrite.md .md 44 symbols added
+ Commit ID v2 — History Rewrite Spec section Commit ID v2 — History Rewrite Spec L1–273
+ Dry-Run Mode (--dry-run) section Dry-Run Mode (--dry-run) L216–229
+ Edge Cases section Edge Cases L229–246
+ table@L231 section table@L231 L231–243
+ Execution Order (Workspace) section Execution Order (Workspace) L246–258
+ Files to Touch section Files to Touch L127–152
+ code[bash]@L144 variable variable code[bash]@L144 L144–149
+ table@L129 section table@L129 L129–141
+ New compute_commit_id Formula section New compute_commit_id Formula L90–114
+ code@L100 variable variable code@L100 L100–103
+ code@L94 variable variable code@L94 L94–97
+ Phases section Phases L258–273
+ table@L260 section table@L260 L260–273
+ Problems Fixed section Problems Fixed L3–47
+ 1 — Key-swap attack surface section 1 — Key-swap attack surface L5–12
+ 2 — author not bound to commit ID section 2 — author not bound to commit ID L12–17
+ 3 — repo_id not bound to commit ID section 3 — repo_id not bound to commit ID L17–21
+ 4 — Bare base64 signature prefix section 4 — Bare base64 signature prefix L21–27
+ 5 — format_version schema versioning field section 5 — format_version schema versioning field L27–33
+ 6 — branch field semantics are misleading section 6 — branch field semantics are misleading L33–38
+ 7 — Legacy object store paths (no algo directory) section 7 — Legacy object store paths (no algo directory) L38–47
+ Schema Changes to CommitRecord section Schema Changes to CommitRecord L114–127
+ table@L116 section table@L116 L116–120
+ Solution — muse code migrate section Solution — muse code migrate L47–90
+ Part A — Commit DAG replay section Part A — Commit DAG replay L59–69
+ Part B — Object path migration section Part B — Object path migration L69–90
+ code@L75 variable variable code@L75 L75–79
+ code[bash]@L52 variable variable code[bash]@L52 L52–56
+ muse code migrate Algorithm section muse code migrate Algorithm L152–216
+ Step 0 — Preflight section Step 0 — Preflight L154–158
+ Step 1 — Safety bundle section Step 1 — Safety bundle L158–164
+ code[bash]@L160 variable variable code[bash]@L160 L160–163
+ Step 2 — Load repo_id section Step 2 — Load repo_id L164–170
+ code@L166 variable variable code@L166 L166–169
+ Step 3 — Collect all commits section Step 3 — Collect all commits L170–174
+ Step 4 — Topological sort (Kahn's algorithm) section Step 4 — Topological sort (Kahn's algorithm) L174–178
+ Step 5 — Rewrite each commit (Part A) section Step 5 — Rewrite each commit (Part A) L178–188
+ code@L180 variable variable code@L180 L180–187
+ Step 6 — Update branch heads section Step 6 — Update branch heads L188–192
+ Step 7 — Delete old commit files section Step 7 — Delete old commit files L192–196
+ Step 8 — Migrate legacy object paths (Part B) section Step 8 — Migrate legacy object paths (Part B) L196–208
+ code@L198 variable variable code@L198 L198–207
+ Step 9 — Verify section Step 9 — Verify L208–216
+ code[bash]@L210 variable variable code[bash]@L210 L210–213
~ muse/cli/commands/read_commit.py .py 2 symbols modified
~ register
~ run
~ muse/cli/commands/verify.py .py
← Older Oldest on task/docstring-cleanup
All commits
Newer → Latest on task/docstring-cleanup

0 comments

No comments yet. Be the first to start the discussion.

To add a comment, use the Muse CLI: muse hub commit comment sha256:68ba6ffcc79cf1e78224815932cd956e8a48b8f7b2233a5788c20701b3b7df40 --body "your comment"