Change godoc formatting to match Temporal conventions - #95
Open
dplyukhin wants to merge 8 commits into
Open
Conversation
tconley1428
reviewed
Jul 31, 2026
- Add newline after the autogenerated comment so it doesn't look like a package doc - Capitalize "id" as "ID" instead of "Id" to match the Go SDK - Change godoc formatting to match the Go SDK
dplyukhin
force-pushed
the
godoc-formatting
branch
from
August 18, 2026 15:25
0fc9cf6 to
cc383b9
Compare
tconley1428
reviewed
Aug 20, 2026
| public string TaskQueue { get; set; } | ||
| /// <summary> | ||
| /// Total workflow execution timeout, including retries and continue-as-new. | ||
| /// Total workflow execution timeout, including retries and continue-as-new. Defaults to unlimited. |
Collaborator
There was a problem hiding this comment.
Have we confirmed that these defaults are definitely true in every language we're going to generate?
Contributor
Author
There was a problem hiding this comment.
I did a quick trace before I added the docs and was reasonably confident; in every language we generate, an option being none will become an unset proto field, so the defaults are set by the server. That said, I figured the right place to confirm this type of thing is when we try to merge into the SDKs themselves. That said, this PR isn't really the place to do it anyway because our source of truth is temporalio/api. What do you think?
Collaborator
There was a problem hiding this comment.
I don't follow that last bit, but if this is common behavior I think it is okay to go in.
tconley1428
approved these changes
Aug 21, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
What was changed
Why?
To match the Go SDK
Checklist
Closes
How was this tested: