Skip to content

Correct the Go README claim about when Send blocks#330

Open
etbyrd wants to merge 1 commit into
mainfrom
correct-go-readme-wait-blocking-claim
Open

Correct the Go README claim about when Send blocks#330
etbyrd wants to merge 1 commit into
mainfrom
correct-go-readme-wait-blocking-claim

Conversation

@etbyrd

@etbyrd etbyrd commented Jul 20, 2026

Copy link
Copy Markdown
Member

sdk-go/README.md stated unconditionally:

Send, Reply, and Forward keep the HTTP request open until Primitive's downstream SMTP transaction completes. Use a context deadline long enough for SMTP delivery, typically 30-60 seconds.

That is only true when Wait is set. Without it, the API returns once the message is accepted for delivery, so the guidance pushed a needlessly long context deadline onto the common non-waiting path.

Two things wrong, not one:

  • Blocking is conditional on Wait, not the default.
  • Forward has no Wait field at all (ForwardParams in sdk-go/client.go exposes To, BodyText, Subject, From, IdempotencyKey only), so it can never block on SMTP. Only SendParams and ReplyParams carry Wait.

The Node and Python READMEs already describe this correctly. This brings Go in line with their wording.

Verification

  • ForwardParams has no Wait field: confirmed in sdk-go/client.go.
  • Non-wait behavior: the server returns after accepting the outbound message; blocking-until-delivery-outcome is gated on wait === true in the send-mail handler.
  • Docs-only change; no code paths touched.

The README stated unconditionally that Send, Reply, and Forward keep the
HTTP request open until the downstream SMTP transaction completes, and told
readers to size their context deadline for 30-60 seconds accordingly.

That is only true when Wait is set. Without it the call returns once the
message is accepted for delivery, so the advice pushed a needlessly long
deadline onto the common path. Forward has no Wait field at all and always
returns on acceptance.

The Node and Python READMEs already describe this correctly; this brings Go
in line with them.
@greptile-apps

greptile-apps Bot commented Jul 20, 2026

Copy link
Copy Markdown

Confidence Score: 5/5

This looks safe to merge.

  • No blocking issues found in the changed README text.
  • The documented wait behavior matches the Go SDK API shape already inspected.

Important Files Changed

Filename Overview
sdk-go/README.md Updates the Go SDK timeout guidance to match the documented wait behavior for send, reply, and forward.

Reviews (1): Last reviewed commit: "Correct the Go README claim about when S..." | Re-trigger Greptile

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.

1 participant