Skip to content

gorums: align call and generator documentation with behavior - #433

Open
meling wants to merge 4 commits into
feature/424/generated-code-boundaryfrom
fix/426/documentation-consistency
Open

meling wants to merge 4 commits into
feature/424/generated-code-boundaryfrom
fix/426/documentation-consistency

Conversation

@meling

@meling meling commented Nov 1, 2026

Copy link
Copy Markdown
Member

Closes #426.

Stack: #430 → #431 → this PR.
Base: feature/424/generated-code-boundary (#431).

Changes

  • Correct the user and developer guides for lazy call handles, nil nodes, empty configurations, and one-way send completion.
  • Shorten the generated alias and internal call comments, and describe the generated method contracts accurately.
  • Regenerate checked-in protobuf sources and generator goldens from the updated comments.

Verification

  • go test ./... in the root, benchkit, and examples modules.
  • make modernize
  • make goplscheck
  • git diff --check

Copilot AI lite review requested due to automatic review settings November 1, 2026 22:03

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 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 file
  • benchkit/gorums.pb.go: Generated file
  • cmd/protoc-gen-gorums/gengorums/template_static.go: Generated file
  • examples/storage/proto/gorums.pb.go: Generated file
  • internal/tests/correctable/correctable_gorums.pb.go: Generated file
  • internal/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
meling force-pushed the fix/426/documentation-consistency branch from 4182899 to 087aac8 Compare November 2, 2026 15:55
@meling
meling added this pull request to stack #432 November 2, 2026 16:12
@meling
meling force-pushed the fix/426/documentation-consistency branch from 087aac8 to f731bf7 Compare November 2, 2026 16:48
@meling
meling force-pushed the fix/426/documentation-consistency branch from f731bf7 to f1e73d1 Compare November 2, 2026 17:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants