Skip to content

docs: correct sync and async gRPC client examples - #1349

Open
dajiaohuang wants to merge 1 commit into
dapr:mainfrom
dajiaohuang:fix/client-doc-examples-dco-20261030
Open

dajiaohuang wants to merge 1 commit into
dapr:mainfrom
dajiaohuang:fix/client-doc-examples-dco-20261030

Conversation

@dajiaohuang

Copy link
Copy Markdown

Description

Correct four copyable examples in both the synchronous and asynchronous gRPC client docstrings:

  • Use the existing max_grpc_message_length constructor keyword.
  • Make the single query-string pair a tuple of pairs.
  • Add the missing comma and remove the unsupported state argument in get_state.
  • Quote the second key in get_bulk_state.

Only docstrings change; the executable ASTs of both files are unchanged.

Local validation on Python 3.13:

  • Full prescribed unit command (pytest -m "not e2e" ./tests --ignore=tests/integration --ignore=tests/examples): 2172 passed, 41 deselected.
  • Ruff lint: passed; format check: 538 files already formatted.
  • MyPy with a fresh cache and its requested stubs installed: no issues in 230 source files.
  • Eight temporary doc-contract checks (syntax, SDK signature binding, key literals, SDK query encoding): 0/8 before → 8/8 after. These checks do not instantiate clients or contact a sidecar. No permanent tests are added for this documentation-only correction.

Issue reference

No linked issue; this is a small correction to existing documentation examples, not an API or behavior change.

Checklist

  • Code compiles correctly
  • Created/updated tests
  • Extended the documentation

Signed-off-by: wushuwen <mikewushuwen@outlook.com>
@dajiaohuang
dajiaohuang requested review from a team as code owners October 29, 2026 20:16
@CasperGN CasperGN self-assigned this Oct 29, 2026
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.

2 participants