Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More readme updates. #300

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from
Draft

Conversation

Bostwickenator
Copy link
Contributor

@Bostwickenator Bostwickenator commented Jul 6, 2023

More updates to the readme file. Work in process.

README.md Outdated
@@ -278,7 +274,7 @@ iWF allows you to start a workflow with a fixed cron schedule like below
// or timed out, the workflow will be retried based on the retry policy. While the workflow is retrying, it won't
// schedule its next run. If the next schedule is due while the workflow is running (or retrying), then it will skip
that
// schedule. Cron workflow will not stop until it is terminated or cancelled (by returning cadence.CanceledError).
// schedule. Cron workflow will not stop until it is terminated or canceled (by returning cadence.CanceledError).
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cadence.CanceledError seems incorrect here given the two backends.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ahh right. I think we can just remove this part. Returning cancel error is not supported in IWF. The only way to cancel a workflow is call the stop workflow api ( the stopType is cancel by default)

@Bostwickenator
Copy link
Contributor Author

I'll resolve the conflicts shortly.

@longquanzheng
Copy link
Contributor

I'll resolve the conflicts shortly.

Btw there is only one conflict. There is a resolve conflict button in this PR and you can use it to resolve it easily

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.

None yet

2 participants