Add missing documentation for exposed structs in internal package#2232
Open
brucearctor wants to merge 6 commits intotemporalio:mainfrom
Open
Add missing documentation for exposed structs in internal package#2232brucearctor wants to merge 6 commits intotemporalio:mainfrom
brucearctor wants to merge 6 commits intotemporalio:mainfrom
Conversation
yuandrew
reviewed
Mar 24, 2026
Contributor
yuandrew
left a comment
yuandrew
left a comment
There was a problem hiding this comment.
Thanks for the contribution, left a few comments to address
| ActivityType ActivityType | ||
| // TaskQueue is the name of the task queue that the activity needs to be scheduled on. | ||
| TaskQueue string | ||
| Namespace string // Namespace of this activity. |
Contributor
There was a problem hiding this comment.
Looks like some of these got missed due to having inline comments. Can we make sure the tool flags these to have doc comments, even if they have existing inline comments?
| WorkflowServiceClient workflowservice.WorkflowServiceClient | ||
| // Namespace is the namespace for the replay. | ||
| Namespace string | ||
| // OriginalExecution is the execution used to start the replay. |
Contributor
There was a problem hiding this comment.
Misleading comment, this is the original workflow execution being replayed, not "used to start the replay."
Co-authored-by: Andrew Yuan <theandrewyuan@gmail.com>
brucearctor
commented
Mar 24, 2026
| type GetWorkerBuildIdCompatibilityOptions struct { | ||
| // TaskQueue is the task queue to query. | ||
| TaskQueue string | ||
| // MaxSets is the maximum number of sets to return. |
Contributor
Author
There was a problem hiding this comment.
seems singular.
Contributor
Author
thanks for thorough review. I believe I addressed these! |
- Convert inline-only comments to proper doc comments (activity.go, workflow.go) - Remove duplicate inline comments where doc comments exist (activity.go, workflow.go) - Fix Chinese character in HeartbeatTimeout comment (session.go) - Fix plural grammar: Args/Options/Details 'is' to 'are' (interceptor.go) - Add operation context to WorkflowID/RunID comments (interceptor.go) - Capitalize cpu to CPU in comments (resource_tuner.go) - Expand PID: P=Proportional, I=Integral, D=Derivative (resource_tuner.go) - Fix misleading Input comment per reviewer suggestion (error.go) - Fix misleading OriginalExecution comment (plugin.go) - Fix ID/RunID comment convention in WorkflowExecution (workflow.go) - Simplify checkInternalDocs: skip anonymous fields, check field.Doc only (doclink.go)
brucearctor
commented
Mar 24, 2026
| // CpuOutputThreshold is the CPU output threshold limit. | ||
| CpuOutputThreshold float64 | ||
|
|
||
| // MemPGain is the memory P gain limit threshold. |
Contributor
Author
There was a problem hiding this comment.
Wasn't sure whether to capitalize to P/I/D. Can lowercase if preferred.
yuandrew
reviewed
May 5, 2026
| // Memo can be decoded using data converter (defaultDataConverter, or custom one if set). | ||
| Memo *commonpb.Memo | ||
| // Deprecated: use [Workflow.GetTypedSearchAttributes] instead. | ||
| SearchAttributes *commonpb.SearchAttributes // Value can be decoded using defaultDataConverter. |
Contributor
There was a problem hiding this comment.
hmm, seem to have lost this comment
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.
Fixes #2177