Skip to content

Fixed #175 -- Documented CliTestClient in the public testing API. - #178

Merged
DevilsAutumn merged 2 commits into
DevilsAutumn:mainfrom
harshita-777:main
Jul 27, 2026
Merged

Fixed #175 -- Documented CliTestClient in the public testing API.#178
DevilsAutumn merged 2 commits into
DevilsAutumn:mainfrom
harshita-777:main

Conversation

@harshita-777

@harshita-777 harshita-777 commented Jul 15, 2026

Copy link
Copy Markdown

Summary

Adds CliTestClient to the documented public testing API and covers the client.cli helper in the public typing contract.

Fixes #175.

Changes

  • Added CliTestClient to the Testing row in the reference index.
  • Added CliTestClient to the testing list in the stability page.
  • Added a typing assertion for client.cli matching the existing client.mcp check.
  • Refreshed the docs dependency lockfile to clear npm audit findings for dompurify and postcss.

Checks

  • uv run mypy tests/typing/test_test_client_types.py
  • uv run pytest tests/unit/test_public_package_surface.py -q
  • npm ci
  • npm audit --audit-level=moderate
  • npm run docs:build
  • Commit hook: ruff format, ruff check, mypy

@vercel

vercel Bot commented Jul 15, 2026

Copy link
Copy Markdown

@harshita-777 is attempting to deploy a commit to the Devilsautumn Team on Vercel.

A member of the Team first needs to authorize it.

@greptile-apps

greptile-apps Bot commented Jul 15, 2026

Copy link
Copy Markdown

Greptile Summary

This PR documents CliTestClient as part of the public testing API. The main changes are:

  • Adds CliTestClient to the testing symbols in the reference index.
  • Adds CliTestClient to the stability page’s public import boundary.
  • Adds a typing assertion for TestClient.cli returning CliTestClient.
  • Refreshes docs lockfile entries for patched dev dependencies.

Confidence Score: 4/5

Safe to merge after a small documentation consistency update.

The changes are narrow, and the only accepted issue is non-blocking documentation copy drift.

Files Needing Attention: docs/en/dev/reference/index.md

T-Rex T-Rex Logs

What T-Rex did

  • Logs were captured from commands run in the repository, including the command, working directory, and exit code.
  • The mypy log shows the process exit with code 0, indicating successful type-checking.
  • The pytest log reports 6 passed, confirming the test suite completed with all tests passing.
  • The npm audit log reports no vulnerabilities found.
  • The docs build log shows the build completed successfully with exit code 0.

View all artifacts

T-Rex Ran code and verified through T-Rex

Important Files Changed

Filename Overview
docs/en/dev/reference/index.md Adds CliTestClient to the public testing symbol table; the Testing page description should also mention CLI coverage.
docs/en/dev/stability.md Adds CliTestClient to the documented top-level testing imports in the stability/public boundary page.
package-lock.json Refreshes docs dev transitive dependencies (dompurify, postcss, and nanoid) to published patch versions without manifest changes.
tests/typing/test_test_client_types.py Adds a public typing assertion that TestClient.cli exposes CliTestClient, matching the existing MCP helper contract.

Reviews (4): Last reviewed commit: "Refs #175 -- Updated docs dependency loc..." | Re-trigger Greptile

@DevilsAutumn

Copy link
Copy Markdown
Owner

Hi @harshita-777 , Thanks for this patch. Can you please make sure that all the contribution guidelines are followed ? I see a few problems :

  • Changes must be there in a new branch
  • There should be only one commit msg following the convention given in our guidelines.
  • PR title is also incorrect.

@DevilsAutumn

Copy link
Copy Markdown
Owner

Hi @harshita-777 , any updates on this?

@DevilsAutumn DevilsAutumn changed the title docs: add CliTestClient to reference index and stability page Fixed #175 -- Documented CliTestClient in the public testing API. Jul 27, 2026
@DevilsAutumn
DevilsAutumn merged commit a680eb6 into DevilsAutumn:main Jul 27, 2026
6 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add CliTestClient to the public testing docs lists

2 participants