Skip to content

Commit ea11a06

Browse files
authored
Fix README.md and lint errors (#74)
1 parent b46ce50 commit ea11a06

File tree

5 files changed

+14
-19
lines changed

5 files changed

+14
-19
lines changed

CONTRIBUTING.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Developing temporal-sdk
1+
# Developing Temporal Go SDK
22

3-
This doc is intended for contributors to `temporal-client` (hopefully that's you!)
3+
This doc is intended for contributors to `temporal-go-sdk` (hopefully that's you!)
44

55
**Note:** All contributors also need to fill out the [Temporal Contributor License Agreement](https://gist.github.com/samarabbas/7dcd41eb1d847e12263cc961ccfdb197) before we can merge in any of your changes
66

@@ -10,12 +10,11 @@ This doc is intended for contributors to `temporal-client` (hopefully that's you
1010

1111
## Checking out the code
1212

13-
Make sure the repository is cloned to the correct location:
13+
Make sure the repository is cloned to the preferred location:
1414
(Note: the path is `go.temporal.io/temporal/` instead of github repo)
1515

1616
```bash
1717
go get go.temporal.io/temporal/...
18-
cd $GOPATH/src/go.temporal.io/temporal
1918
```
2019

2120
## Licence headers

README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
[Temporal](https://github.com/temporalio/temporal) is a distributed, scalable, durable, and highly available orchestration engine used to execute asynchronous long-running business logic in a scalable and resilient way.
44

5-
`temporal-client` is the framework for authoring workflows and activities.
5+
`temporal-go-sdk` is the framework for authoring workflows and activities using Go language.
66

77
## How to use
88

9-
Make sure you clone this repo into the correct location.
9+
Clone this repo into the preferred location.
1010

1111
```bash
12-
git clone [email protected]:temporalio/temporal-go-client.git $GOPATH/src/go.temporal.io/temporal
12+
git clone [email protected]:temporalio/temporal-go-sdk.git
1313
```
1414

1515
or
@@ -20,11 +20,11 @@ go get go.temporal.io/temporal
2020

2121
See [samples](https://github.com/temporalio/temporal-go-samples) to get started.
2222

23-
Documentation is available [here](https://cadenceworkflow.io/docs/07_goclient/).
23+
Documentation is available [here](https://docs.temporal.io/docs/07_goclient/).
2424
You can also find the API documentation [here](https://godoc.org/go.temporal.io/temporal).
2525

2626
## Contributing
27-
We'd love your help in making the Temporal Go client great. Please review our [contribution guidelines](CONTRIBUTING.md).
27+
We'd love your help in making the Temporal Go SDK great. Please review our [contribution guidelines](CONTRIBUTING.md).
2828

2929
## License
3030
MIT License, please see [LICENSE](LICENSE) for details.

internal/interceptors.go

+3-2
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,11 @@
2121
package internal
2222

2323
import (
24-
"github.com/uber-go/tally"
2524
"time"
25+
26+
"github.com/uber-go/tally"
27+
"go.uber.org/zap"
2628
)
27-
import "go.uber.org/zap"
2829

2930
// WorkflowInterceptorFactory is used to create a single link in the interceptor chain
3031
type WorkflowInterceptorFactory interface {

internal/worker.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ type (
7171
TaskListActivitiesPerSecond float64
7272

7373
// Optional: Sets the maximum number of goroutines that will concurrently poll the
74-
// cadence-server to retrieve activity tasks. Changing this value will affect the
74+
// temporal-server to retrieve activity tasks. Changing this value will affect the
7575
// rate at which the worker is able to consume tasks from a task list.
7676
// default: 2
7777
MaxConcurrentActivityTaskPollers int
@@ -88,7 +88,7 @@ type (
8888
WorkerDecisionTasksPerSecond float64
8989

9090
// Optional: Sets the maximum number of goroutines that will concurrently poll the
91-
// cadence-server to retrieve decision tasks. Changing this value will affect the
91+
// temporal-server to retrieve decision tasks. Changing this value will affect the
9292
// rate at which the worker is able to consume tasks from a task list.
9393
// default: 2
9494
MaxConcurrentDecisionTaskPollers int

test/workflow_test.go

+1-6
Original file line numberDiff line numberDiff line change
@@ -422,12 +422,7 @@ func (w *Workflows) ConsistentQueryWorkflow(ctx workflow.Context, delay time.Dur
422422
ScheduleToCloseTimeout: 5 * time.Second,
423423
})
424424

425-
workflowInfo := internal.GetWorkflowInfo(laCtx)
426-
if &workflowInfo.WorkflowType == nil {
427-
return errors.New("failed to get work flow type")
428-
}
429-
430-
workflow.ExecuteLocalActivity(laCtx, LocalSleep, delay).Get(laCtx, nil)
425+
_ = workflow.ExecuteLocalActivity(laCtx, LocalSleep, delay).Get(laCtx, nil)
431426
queryResult = signalData
432427
return nil
433428
}

0 commit comments

Comments
 (0)