lostluck commented on code in PR #33337:
URL: https://github.com/apache/beam/pull/33337#discussion_r1882883080


##########
sdks/go/pkg/beam/runners/prism/internal/engine/elementmanager.go:
##########
@@ -628,6 +655,11 @@ type Block struct {
        Transform, Family string
 }
 
+// StaticTimerID represents the static user identifiers for a timer.
+type StaticTimerID struct {
+       Transform, TimerFamily string

Review Comment:
   As discussed offline, I renamed the Transform field to TransformID, which 
makes comments on both fields redundant (they'd be of the form "TransformID is 
the ID of the transform containing the timer" etc).
   
   Just to re-iterate the other point I made offline, documentation is best 
served in appropriate contexts. In this case, this is a type in an internal 
package, not intended for arbitrary user use, so the documentation bar is 
lower. That context is safe enough to assume that whomever needs to make a 
change here knows what a Timer is and how they are identified.
   
   Otherwise they should really look into the beam Protos directly to start. 
(or some kind of SDK Authoring guide...)



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to