style: clarify workflow activity retry fields/defaults

[passuied]

Describe the WORKFLOW SDK feature

There are multiple gotchas in the workflow activity retry policies as described below:

ACTIVITY_RETRY_POLICY = RetryPolicy(
    first_retry_interval=timedelta(seconds=1),
    
   # max_number_of_attempts is the total attempt count, not the retry count
    max_number_of_attempts=5,
    backoff_coefficient=3,
   
    # Set max_retry_interval else there won't be any retries
    max_retry_interval=timedelta(seconds=10),
   
    # DON'T set retry_timeout. If the timeout is hit, the entire workflow fails and the
    # final activity isn't executed.
)

https://github.com/dapr/python-sdk/blob/main/ext/dapr-ext-workflow/dapr/ext/workflow/retry_policy.py#L26
go-sdk ref https://github.com/dapr/durabletask-go/blob/main/workflow/workflow.go#L147

acceptance criteria:

• update the field values to sensible defaults if not provided
• max_number_of_attempts can remain as is, or become deprecated (still supported) and a new field of max_attempts added that will eventuallyyyyy replace this field
• all field docs strings updated to be clearer on what they do
• ensure that retries still apply if max_retry_interval is set
• update retry_timeout to indicate that if this fails then the workflow will fail

Release Note

RELEASE NOTE: ADD Clarify workflow activity retry policies fields and defaults

[dapr-bot]

This issue has been automatically marked as stale because it has not had activity in the last 60 days. It will be closed in the next 7 days unless it is tagged (pinned, good first issue, help wanted or triaged/resolved) or other activity occurs. Thank you for your contributions.

[filintod]

one bug mentioned here is being fixed in dapr/durabletask-python#33. Also the README.md in that PR mentions some of the information on the gotchas above, but it might be good to bring those to the docs here

@passuied please check this PR readme for comments dapr/durabletask-python@d9ed06e#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5

[dapr-bot]

This issue has been automatically marked as stale because it has not had activity in the last 60 days. It will be closed in the next 7 days unless it is tagged (pinned, good first issue, help wanted or triaged/resolved) or other activity occurs. Thank you for your contributions.