[fix] Complete comment on ProducerInterceptor interface BeforeSend method #1119
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.
Motivation
The comment against the
BeforeSend
method in theProducerInterceptor
interface is incomplete. Whilst it's fairly easy to infer the missing words, the comment is clearer when complete.pulsar-client-go/pulsar/producer_interceptor.go
Lines 21 to 22 in af56e60
Modifications
Completed the comment so it reads
Verifying this change
This change is a trivial rework / code cleanup without any test coverage.
This is the first time I've come across these interceptors so I've verified that the
BeforeSend
method can modify the message: https://go.dev/play/p/UQ4Q1MNPOpfDoes this pull request potentially affect one of the following parts:
Documentation