Add godoc to workflow.EdgeConnection.Equal#748
Conversation
There was a problem hiding this comment.
Pull request overview
Adds missing GoDoc documentation to the exported workflow.EdgeConnection.Equal method to make the workflow edge equality API consistently documented and to clarify the ordered source/sink equality semantics.
Changes:
- Added a GoDoc comment to
EdgeConnection.Equaldescribing that equality is based on orderedSourceIDsandSinkIDs.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This comment has been minimized.
This comment has been minimized.
github-actions
Bot
added
the
parity-approved
Document the exported EdgeConnection.Equal method so the equality API is fully documented alongside the already-documented Edge.Equal and the EdgeConnection type. The comment states the actual comparison: equality of the ordered SourceIDs and SinkIDs slices.
1bf9077 to
29e93e5
Compare
Parity Review: ✅ No IssuesThis PR adds a godoc comment to the already-exported Scope determination: Out of scope for cross-repo parity concerns. The Result: Warning Firewall blocked 1 domainThe following domain was blocked by the firewall during workflow execution:
network:
allowed:
- defaults
- "awmgmcpg"See Network Configuration for more information.
|
What
Adds a godoc comment to the exported
EdgeConnection.Equalmethod inworkflow/edge.go.Why
EdgeConnection.Equalwas the only undocumented member of the workflow edge equality API: the siblingEdge.Equalalready carries a godoc comment, and theEdgeConnectiontype itself is documented. Documenting all exported members keeps the API surface consistent and matches the .NET/Python graph model, where the edge-connection equality semantics (equality over the ordered source and sink collections) are explicit. The comment states exactly what the implementation does —slices.Equalon both the orderedSourceIDsandSinkIDs.Testing
Docs-only change. Verified with:
go build ./...go vet ./workflow/...go test ./workflow/...go doc ./workflow EdgeConnection.Equalrenders the new comment.