Skip to content

Commit

Permalink
Update some docs around grpc Dial options (temporalio#1514)
Browse files Browse the repository at this point in the history
Update some docs around grpc Dial options
  • Loading branch information
Quinn-With-Two-Ns committed Jun 20, 2024
1 parent b550a5e commit 3ceb659
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
3 changes: 1 addition & 2 deletions client/client.go
Original file line number Diff line number Diff line change
Expand Up @@ -940,8 +940,7 @@ func NewClientFromExistingWithContext(ctx context.Context, existingClient Client
// NewNamespaceClient creates an instance of a namespace client, to manage
// lifecycle of namespaces. This will not attempt to connect to the server
// eagerly and therefore may not fail for an unreachable server until a call is
// made. grpc.WithBlock can be passed as a gRPC dial option to connection
// options to eagerly connect.
// made.
func NewNamespaceClient(options Options) (NamespaceClient, error) {
return internal.NewNamespaceClient(options)
}
Expand Down
3 changes: 2 additions & 1 deletion internal/client.go
Original file line number Diff line number Diff line change
Expand Up @@ -538,7 +538,8 @@ type (
MaxPayloadSize int

// Advanced dial options for gRPC connections. These are applied after the internal default dial options are
// applied. Therefore any dial options here may override internal ones.
// applied. Therefore any dial options here may override internal ones. Dial options WithBlock, WithTimeout,
// WithReturnConnectionError, and FailOnNonTempDialError are ignored since [grpc.NewClient] is used.
//
// For gRPC interceptors, internal interceptors such as error handling, metrics, and retrying are done via
// grpc.WithChainUnaryInterceptor. Therefore to add inner interceptors that are wrapped by those, a
Expand Down

0 comments on commit 3ceb659

Please sign in to comment.