docs: misc. corrections #83
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
iand675
reviewed
Apr 8, 2025
sdk/src/Temporal/Client/Types.hs
Outdated
| It is recommend to specify 'WorkflowId' in most cases, as it is used to uniquely identify a 'Workflow' execution, | ||
| but if one is not specified then a random UUID will be generated. | ||
| 'WorkflowId's will be used to uniquely identify a 'Workflow' execution, and as such should incorporate a pseudo- | ||
| random component (e.g. a UUID). |
There was a problem hiding this comment.
I'd probably not advise using a pseudo-random component as a first choice. We could probably say "'WorkflowId's are used to uniquely identify a running 'Workflow'." for maximum precision.
There was a problem hiding this comment.
how do you feel about the updated phrasing?
jkachmar
force-pushed
the
jkachmar/update-haddocks
branch
from
cae10db to
da86131
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
description
noticed a few (small) Haddock corrections to be made.