Skip to content

Commit 52aafbc

Browse files
committed
go doc fix
1 parent 52d63fd commit 52aafbc

File tree

2 files changed

+8
-15
lines changed

2 files changed

+8
-15
lines changed

CHANGELOG.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
55
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

77
## [Unreleased]
8+
### Added
9+
- Added worker.NewV2 with validation on decision poller count (#1370)
10+
811
## [v1.2.10] - 2024-07-10
912
### Added
1013
- Revert "Handle panics while polling for tasks (#1352)" (#1357)
@@ -83,16 +86,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
8386
- Fixed in TestEnv workflow interceptor is not propagated correctly for child workflows #1289
8487

8588
## [v1.0.2] - 2023-09-25
86-
### Added
89+
### Added
8790
- Add a structured error for non-determinism failures
8891

89-
### Changed
90-
- Do not log when automatic heart beating fails due to cancellations
92+
### Changed
93+
- Do not log when automatic heart beating fails due to cancellations
9194

9295
## [v1.0.1] - 2023-08-14
9396
### Added
9497
- Emit cadence worker's hardware utilization inside worker once per host by @timl3136 in #1260
95-
### Changed
98+
### Changed
9699
- Updated supported Go version to 1.19
97100
- Log when the automatic heartbeating fails
98101
- Updated golang.org/x/net and github.com/prometheus/client_golang

worker/worker.go

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -269,16 +269,7 @@ const (
269269
ShadowModeContinuous = internal.ShadowModeContinuous
270270
)
271271

272-
// New creates an instance of worker for managing workflow and activity executions.
273-
//
274-
// service - thrift connection to the cadence server
275-
// domain - the name of the cadence domain
276-
// taskList - is the task list name you use to identify your client worker, also
277-
// identifies group of workflow and activity implementations that are
278-
// hosted by a single worker process
279-
// options - configure any worker specific options like logger, metrics, identity
280-
//
281-
// DEPRCATED: use NewV2 instead since this implementation will panic on error
272+
// Deprecated: use NewV2 instead since this implementation will panic on error
282273
func New(
283274
service workflowserviceclient.Interface,
284275
domain string,
@@ -300,7 +291,6 @@ func New(
300291
// identifies group of workflow and activity implementations that are
301292
// hosted by a single worker process
302293
// options - configure any worker specific options like logger, metrics, identity
303-
// Returns an error if the worker cannot be created.
304294
func NewV2(
305295
service workflowserviceclient.Interface,
306296
domain string,

0 commit comments

Comments
 (0)