fix(spec): remove §26 Library API Surface + add protocol-only guard#66
Merged
Conversation
§26 was added by the x5u.5 audit under the wrong mandate — that SPEC.md should document the library's API. SPEC.md is a tmux wire protocol reference; library API surface has no place here. Also adds a prominent guard at the top of the file stating the same.
There was a problem hiding this comment.
Pull request overview
This PR clarifies that SPEC.md is intended to be a tmux wire-protocol reference (not library API documentation) by adding an explicit “protocol-only” guard at the top and removing the previously-added Library API Surface section.
Changes:
- Adds a prominent protocol-only scope guard at the start of
SPEC.md. - Removes “§26. Library API Surface” (library exports/methods/events documentation) from
SPEC.md.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Remove dangling §26.2 reference from wait-exit flag row; describe the unblocking behavior in protocol terms instead of pointing at a deleted library section - Acknowledge legacy library notes in guard header; they are tracked for removal by tmux-audit-q17, not added to by this PR
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
## 26. Library API Surface(§26.1–§26.4) added by the x5u.5 audit under the wrong mandateWhy
SPEC.md is a tmux wire protocol reference. §26 described the library's public API — method signatures, exports, event names. That is library documentation, not protocol documentation, and has no place here.
The guard note explicitly addresses the most common misreading: "not described in this spec" does not mean "should be removed from the library." The spec is a floor, not a ceiling.