Repository navigation
Conversation
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues remain, with the documented and regenerated API contract updates addressing the lifecycle and behavior clarifications despite two minor documentation follow-ups.
No open issues 🎉
6 files not reviewed
benchkit/benchmark/gorums.pb.go: Generated filebenchkit/gorums.pb.go: Generated filecmd/protoc-gen-gorums/gengorums/template_static.go: Generated fileexamples/storage/proto/gorums.pb.go: Generated fileinternal/tests/correctable/correctable_gorums.pb.go: Generated fileinternal/tests/correctable/gorums.pb.go: Generated file
What changed in this PR
This pull request aligns Gorums documentation and generated API comments with the current lazy call-handle lifecycle, nil-node behavior, empty-configuration errors, and one-way send completion semantics.
Changes:
- Clarifies lazy unicast, quorum, multicast, and streaming-call contracts across public and internal documentation.
- Updates generator templates and source comments to better describe generated method behavior.
- Regenerates checked-in protobuf outputs and generator golden files.
Two minor documentation follow-ups were noted: leading proto comments can still override the quorum-call fallback text, and the runtime Unicast comment still implies eager dispatch.
| File | Description |
|---|---|
internal/tests/unresponsive/gorums.pb.go |
Regenerated alias documentation. |
internal/tests/tls/gorums.pb.go |
Regenerated alias documentation. |
internal/tests/ordering/ordering_gorums.pb.go |
Updated quorum-call contract documentation. |
internal/tests/ordering/gorums.pb.go |
Regenerated alias documentation. |
internal/tests/oneway/oneway_gorums.pb.go |
Updated multicast and unicast handle documentation. |
internal/tests/oneway/gorums.pb.go |
Regenerated alias documentation. |
internal/tests/multiservice/multiservice_gorums.pb.go |
Updated quorum and one-way call documentation. |
internal/tests/multiservice/gorums.pb.go |
Regenerated alias documentation. |
internal/tests/metadata/gorums.pb.go |
Regenerated alias documentation. |
internal/tests/correctable/gorums.pb.go |
Regenerated alias documentation. |
internal/tests/correctable/correctable_gorums.pb.go |
Updated quorum and streaming-call documentation. |
internal/testprotos/testdata/nodeonly/nodeonly_gorums.pb.go.golden |
Updated generated unicast documentation. |
internal/testprotos/testdata/nodeonly/gorums.pb.go.golden |
Updated generated alias documentation. |
internal/testprotos/testdata/clientnames/gorums.pb.go.golden |
Updated generated alias documentation. |
internal/testprotos/testdata/calltypes/quorumcall/quorumcall_gorums.pb.go.golden |
Updated generated quorum-call documentation. |
internal/testprotos/testdata/calltypes/quorumcall/gorums.pb.go.golden |
Updated generated alias documentation. |
internal/testprotos/testdata/calltypes/multiservice/multiservice_gorums.pb.go.golden |
Updated generated quorum and multicast documentation. |
internal/testprotos/testdata/calltypes/multiservice/gorums.pb.go.golden |
Updated generated alias documentation. |
internal/testprotos/testdata/calltypes/multicast/multicast_gorums.pb.go.golden |
Updated generated multicast documentation. |
internal/testprotos/testdata/calltypes/multicast/gorums.pb.go.golden |
Updated generated alias documentation. |
internal/testprotos/testdata/calltypes/importmsgs/importmsgs_gorums.pb.go.golden |
Updated generated quorum-call documentation. |
internal/testprotos/testdata/calltypes/importmsgs/gorums.pb.go.golden |
Updated generated alias documentation. |
internal/impl/unicast.go |
Simplified lazy unicast contract comments. |
internal/impl/remotecall.go |
Simplified remote-call error documentation. |
internal/impl/quorumcall.go |
Clarified lazy quorum-call and streaming-call contracts. |
internal/impl/multicast.go |
Clarified lazy multicast and empty-configuration behavior. |
internal/impl/errors.go |
Clarified when empty-configuration errors are reported. |
examples/storage/proto/gorums.pb.go |
Regenerated alias documentation. |
errors.go |
Clarified nil-node and empty-configuration error timing. |
doc/user-guide.md |
Updated generated API, call lifecycle, and one-way completion guidance. |
doc/dev-guide.md |
Updated call-engine and send-completion documentation. |
doc.go |
Clarified call types, dispatch timing, and node behavior. |
cmd/protoc-gen-gorums/gengorums/template_unicast.go |
Updated generated unicast comments. |
cmd/protoc-gen-gorums/gengorums/template_static.go |
Shortened generated alias comments. |
cmd/protoc-gen-gorums/gengorums/template_quorumcall.go |
Updated generated quorum-call comments. |
cmd/protoc-gen-gorums/gengorums/template_multicast.go |
Updated generated multicast comments. |
cmd/protoc-gen-gorums/dev/aliases.go |
Updated source alias comments used by generation. |
benchkit/gorums.pb.go |
Regenerated alias documentation. |
benchkit/benchmark/gorums.pb.go |
Regenerated alias documentation. |
Review effort: Lite
meling
force-pushed
the
fix/426/documentation-consistency
branch
from
November 2, 2026 15:55
4182899 to
087aac8
Compare
meling
force-pushed
the
fix/426/documentation-consistency
branch
from
November 2, 2026 16:48
087aac8 to
f731bf7
Compare
meling
force-pushed
the
fix/426/documentation-consistency
branch
from
November 2, 2026 17:05
f731bf7 to
f1e73d1
Compare
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
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.
Closes #426.
Stack: #430 → #431 → this PR.
Base:
feature/424/generated-code-boundary(#431).Changes
Verification
go test ./...in the root, benchkit, and examples modules.make modernizemake goplscheckgit diff --check