Skip to content

🔄 Sync code examples from docs-code-eval#2402

Closed
github-actions[bot] wants to merge 2 commits intomainfrom
sync-code-examples-4
Closed

🔄 Sync code examples from docs-code-eval#2402
github-actions[bot] wants to merge 2 commits intomainfrom
sync-code-examples-4

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

@github-actions github-actions bot commented Mar 31, 2026

🔄 Automated Code Examples Sync

This PR syncs ground truth code examples from the docs-code-eval repository.
These examples are used to build the SDK coding cheat sheet.

Note: This PR was generated with the fix in #2400 by running the action from that branch.

Changes

Synced 34 file(s) from docs-code-eval:

  • 17 Python example(s) updated
  • Cheat sheet regenerated

Files Updated

  • Code Examples: snippets/en/_includes/code-examples/*.mdx
  • Cheat Sheet: models/ref/sdk-coding-cheat-sheet/

Review Checklist

  • Verify code examples are correct
  • Check cheat sheet rendering
  • Ensure all examples have proper placeholders
  • Confirm difficulty levels are appropriate

How This Works

This PR was automatically created by the Sync Code Examples workflow, which:

  1. Clones the latest docs-code-eval repository
  2. Copies ground truth examples from ground_truth/
  3. Regenerates the SDK coding cheat sheet
  4. Creates this draft PR if changes are detected

Manual Sync

You can trigger this workflow manually from the Actions tab.


🤖 This is a draft PR. Review the changes and mark as ready when satisfied.

mdlinville and others added 2 commits March 31, 2026 14:54
Auto-sync of ground truth examples from docs-code-eval repository.
Updated 34 file(s).
@github-actions github-actions bot added automated documentation Improvements or additions to documentation code-examples labels Mar 31, 2026
@mdlinville mdlinville requested review from ngrayluna and removed request for mdlinville March 31, 2026 21:57
@mdlinville mdlinville marked this pull request as ready for review March 31, 2026 21:57
@mdlinville mdlinville requested a review from a team as a code owner March 31, 2026 21:57
@mdlinville mdlinville changed the base branch from debug_cheat_sheet_sync_action to main March 31, 2026 21:59
@ngrayluna
Copy link
Copy Markdown
Contributor

Thanks for taking a look. I think it's almost there...it's missing snippets related to sweeps?

@mdlinville
Copy link
Copy Markdown
Contributor

mdlinville commented Mar 31, 2026

Thanks for taking a look. I think it's almost there...it's missing snippets related to sweeps?

We categorize the ground truth snippets by how they are prefixed, to control the order of sections of the cheat sheet. We had no Sweeps examples initially so I didn't deal with that prefix. The resume_run and rewind_run snippets are missing one of run_ or runs_ prefix. I could update the logic to also consider suffix, or we could rename those two snippets to have run_ at the front and they will be picked up automatically.

@mdlinville
Copy link
Copy Markdown
Contributor

mdlinville commented Mar 31, 2026

Thanks for taking a look. I think it's almost there...it's missing snippets related to sweeps?

Just pushed an update into #2400 to start processing Sweeps snippets. We also need https://github.com/wandb/docs-code-eval/pull/13 to merge so we pick up the missing resume / rewind snippets. Then I will close and regenerate this PR to validate those updates.

@mdlinville mdlinville closed this Mar 31, 2026
@mdlinville mdlinville deleted the sync-code-examples-4 branch March 31, 2026 23:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automated code-examples documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants