docs(reference): add run_tests and get_test_job examples - #1400
RizgarOzan wants to merge 1 commit into
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (2)
Included review availability: Your plan provides up to 10 included reviews per hour; 9 remain after this review. 📝 WalkthroughWalkthroughThe testing tool reference now includes concrete examples for running tests, handling stuck jobs, waiting for completion, checking progress, and retrieving test details. ChangesTesting tool documentation
Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~5 minutes Change: Other Suggested reviewers: Merge Risk: ⚪ Minimal · up to The documentation examples are consistent with the supplied tool contracts and safe to merge. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Description
Fills the two
testingpages that still said No examples yet ("Examples in tool reference pages" is listed under Areas That Need Help in CONTRIBUTING). Content only goes inside the<!-- examples:start --><!-- examples:end -->blocks.Type of Change
Changes Made
run_tests: all EditMode tests; specific tests by full name; a namespace viagroup_namesregex; one PlayMode assembly withinit_timeout: 120000;clear_stuck— including how it differs from thetests_running/retry_after_msanswer you get while a job is genuinely running.get_test_job: waiting withwait_timeout(server polls every 2 s and returns onsucceeded/failed/cancelled), a non-blocking progress check (data.progress), andinclude_detailsvsinclude_failed_tests.Every parameter name, default and status value was checked against
Server/src/services/tools/run_tests.pyandMCPForUnity/Editor/Tools/RunTests.cson currentbeta.Testing/Screenshots/Recordings
tools/generate_docs_reference.pypreserves both blocks: regenerating on this branch leaves the two pages unchanged.Related Issues
None.
Summary by CodeRabbit