Commit 05d7dec
committed
fix(skill): address CodeRabbit review — shell-safe examples, doc accuracy, F541
Objective: A public reviewer (CodeRabbit) flagged copy-paste examples that break
in a real shell plus a few doc/lint issues in the skill's reference files.
Approach: Fix the verified findings; decline two by repo convention.
- integration-examples.md: the remote-server example used <ANGLE_BRACKET>
placeholders (a shell parses "<" as input redirection, so the "copy-pasteable"
command failed before ODL ran) -> quoted env var; the JSON reader now uses a
context manager; and a note documents that max_chars bounds size BETWEEN
elements (a single element larger than max_chars is not split).
- options-matrix.md: qualify "a hybrid server is required" for --hybrid-fallback
(the run then completes via local Java as fallback output, not hybrid); and note
that formula/picture enrichment needs the hybrid SERVER's --enrich-* flags, not
just the client's --hybrid-mode full (CodeRabbit's proposed client-flag fix was
wrong -- those are server startup flags).
- sync-skill-refs.py: drop f-prefixes on placeholder-free strings (Ruff F541).
Declined: pinning actions to commit SHAs (repo convention is floating tags -- the
sibling workflows use actions/checkout@v7 / setup-python@v6 unpinned, so pinning
only these two would be inconsistent) and adding a concurrency group (CodeRabbit
itself marked it low value for these light jobs).
Evidence: ran the fixed code, did not just edit it.
- Extracted the fixed chunk_with_citations from the reference and ran it on real
ODL JSON: the context-manager path works and chunks carry {page,bbox}; a
5000-char element with max_chars=1000 becomes its own oversized chunk (matches
the new note).
- Shell-safety before/after: old form -> "bash: PRIVATE_BIND_ADDRESS: No such
file or directory"; fixed form resolves to --host 10.0.0.5.
- sync-skill-refs.py still runs (drift 31=31, exit 0); f-prefixes gone; py_compile OK.
- skill-gate PASS (fences, evals schema, cross-refs, compile, drift).1 parent 203602e commit 05d7dec
3 files changed
Lines changed: 17 additions & 9 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
140 | 140 | | |
141 | 141 | | |
142 | 142 | | |
143 | | - | |
| 143 | + | |
| 144 | + | |
144 | 145 | | |
145 | 146 | | |
146 | 147 | | |
| |||
160 | 161 | | |
161 | 162 | | |
162 | 163 | | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
163 | 167 | | |
164 | 168 | | |
165 | 169 | | |
| |||
285 | 289 | | |
286 | 290 | | |
287 | 291 | | |
288 | | - | |
289 | | - | |
| 292 | + | |
| 293 | + | |
| 294 | + | |
| 295 | + | |
290 | 296 | | |
291 | 297 | | |
292 | 298 | | |
293 | 299 | | |
294 | | - | |
| 300 | + | |
295 | 301 | | |
296 | 302 | | |
297 | 303 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
111 | 111 | | |
112 | 112 | | |
113 | 113 | | |
114 | | - | |
115 | | - | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
116 | 118 | | |
117 | 119 | | |
118 | 120 | | |
| |||
226 | 228 | | |
227 | 229 | | |
228 | 230 | | |
229 | | - | |
| 231 | + | |
230 | 232 | | |
231 | 233 | | |
232 | 234 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
175 | 175 | | |
176 | 176 | | |
177 | 177 | | |
178 | | - | |
| 178 | + | |
179 | 179 | | |
180 | 180 | | |
181 | 181 | | |
182 | 182 | | |
183 | | - | |
| 183 | + | |
184 | 184 | | |
185 | 185 | | |
186 | 186 | | |
| |||
0 commit comments