Skip to content

Commit fdba654

Browse files
committed
docs(convert): document sticky baseline refresh semantics
1 parent 8c522fb commit fdba654

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -257,6 +257,10 @@ j-cli exec <session_id> --file notebook.ipynb --cell 5
257257

258258
**Notebook writeback**: When executing from a py:percent file (one with `# %%` cell markers or a `# ---` front matter block), outputs are automatically written back to the paired `.ipynb`. If `analysis.ipynb` does not yet exist, j-cli creates it automatically. Plain Python scripts without markers are executed normally without creating a notebook.
259259

260+
**Convert baseline refresh**: When `j-cli convert` syncs a canonical managed pair (`foo.py``foo.ipynb`, or `foo.dummy.py``foo.ipynb`) inside a git repo, it also refreshes the sticky pair baseline under `refs/jcli/pair-sync/*`. This lets later drift checks compare against the last successful pair sync instead of falling back to an older `HEAD`.
261+
262+
If you convert to a non-canonical output path such as `foo.py -> custom.ipynb` or `nb.ipynb -> custom.py`, j-cli treats that as an export/conversion only and does **not** refresh the sticky baseline.
263+
260264
## Troubleshooting Hooks
261265

262266
If a hook appears to run but produces no visible effect (silent `exit 0` with no

0 commit comments

Comments
 (0)