Skip to content

Commit 06f8530

Browse files
timsaucerclaude
andcommitted
docs: fold make-pythonic step into PR 3 of upstream sync
Audit-skill-md documents the order `/check-upstream` -> `/make-pythonic` (optional) -> `/audit-skill-md`, but PR 3 of the upstream-sync workflow only listed the first and last. Insert the make-pythonic pass as step 3 so signatures get aligned before the SKILL.md audit, avoiding example churn. Drops the orphan trailing paragraph in favor of inline guidance on when to defer larger reshapes to their own PR. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent e827547 commit 06f8530

1 file changed

Lines changed: 10 additions & 5 deletions

File tree

dev/release/upstream-sync.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,15 @@ documentation so it still matches the surface we ship.
128128
- Skip it (internal-only or already covered by an existing API; record
129129
the decision in the "Evaluated and not requiring exposure" sections of
130130
the skill so future runs don't re-flag it).
131-
3. Run the `audit-skill-md` skill (`.ai/skills/audit-skill-md/SKILL.md`) to
131+
3. (Optional) Run the `make-pythonic` skill
132+
(`.ai/skills/make-pythonic/SKILL.md`) over any newly exposed APIs to
133+
align signatures with the project's Pythonic style (accepting plain
134+
strings for column names, raw Python values where auto-wrapping
135+
applies, etc.). Invoke it from the assistant with `/make-pythonic`.
136+
Running this *before* the audit step means examples in `SKILL.md` get
137+
updated to the final signature in one pass instead of churning twice.
138+
Larger reshapes still belong in their own PR.
139+
4. Run the `audit-skill-md` skill (`.ai/skills/audit-skill-md/SKILL.md`) to
132140
cross-reference the user-facing skill at
133141
[`skills/datafusion_python/SKILL.md`](../../skills/datafusion_python/SKILL.md)
134142
against the current public API. The skill flags stale function names,
@@ -137,13 +145,10 @@ documentation so it still matches the surface we ship.
137145
`/audit-skill-md` (optionally scoped, e.g. `/audit-skill-md dataframe`).
138146
Apply the resulting edits to `SKILL.md` and to the relevant RST pages
139147
under `docs/source/user-guide/common-operations/`.
140-
4. If new aggregate or window functions were exposed in step 2, also update:
148+
5. If new aggregate or window functions were exposed in step 2, also update:
141149
- `docs/source/user-guide/common-operations/aggregations.rst`
142150
- `docs/source/user-guide/common-operations/windows.rst`
143151

144-
PR 3 is the natural place to land small Pythonic-interface improvements
145-
discovered during the audit. Larger reshapes should still get their own PR.
146-
147152
## Why three PRs
148153

149154
- **Bisectable.** If a regression appears, `git bisect` lands on the

0 commit comments

Comments
 (0)