Skip to content

Commit 3d37594

Browse files
committed
docs(CHANGES): Remove references to unimplemented hook methods
why: CHANGES documented bulk hook APIs that don't exist in HooksMixin what: - Remove get_hook_indices, get_hook_values, append_hook, clear_hook - These methods were documented but never implemented - Keep only the implemented methods: set_hook, show_hook, show_hooks, unset_hook, run_hook, set_hooks
1 parent e5a5b9d commit 3d37594

File tree

1 file changed

+2
-20
lines changed

1 file changed

+2
-20
lines changed

CHANGES

Lines changed: 2 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -136,36 +136,18 @@ session.set_hooks('session-renamed', {
136136
1: 'display-message "Hook 1"',
137137
5: 'run-shell "echo hook 5"',
138138
})
139-
140-
# Get all indexed values for a hook
141-
session.get_hook_values('session-renamed')
142-
# SparseArray({0: 'display-message "Hook 0"', 1: '...', 5: '...'})
143-
144-
# Get just the indices
145-
session.get_hook_indices('session-renamed')
146-
# [0, 1, 5]
147-
148-
# Append at next available index
149-
session.append_hook('session-renamed', 'display-message "Hook 6"')
150-
151-
# Clear all indexed values for a hook
152-
session.clear_hook('session-renamed')
153139
```
154140

155141
**Hook methods available on Server, Session, Window, and Pane:**
156142

157143
| Method | Description |
158144
|--------|-------------|
159145
| `set_hook(hook, value)` | Set a hook |
160-
| `show_hook(hook)` | Get hook value |
146+
| `show_hook(hook)` | Get hook value (returns SparseArray for indexed hooks) |
161147
| `show_hooks()` | Get all hooks |
162148
| `unset_hook(hook)` | Remove a hook |
163149
| `run_hook(hook)` | Run a hook immediately |
164-
| `set_hooks(hook, values)` | Set multiple indexed hooks |
165-
| `get_hook_indices(hook)` | Get list of indices |
166-
| `get_hook_values(hook)` | Get all values as SparseArray |
167-
| `append_hook(hook, value)` | Append at next index |
168-
| `clear_hook(hook)` | Remove all indexed values |
150+
| `set_hooks(hook, values)` | Set multiple indexed hooks at once |
169151

170152
#### SparseArray for Indexed Options (#516)
171153

0 commit comments

Comments
 (0)