Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[fix] Complete comment on ProducerInterceptor interface BeforeSend method #1119

Merged
merged 1 commit into from
Oct 24, 2023

Conversation

ojcm
Copy link
Contributor

@ojcm ojcm commented Oct 24, 2023

Motivation

The comment against the BeforeSend method in the ProducerInterceptor interface is incomplete. Whilst it's fairly easy to infer the missing words, the comment is clearer when complete.

// BeforeSend This is called before send the message to the brokers. This method is allowed to modify the
BeforeSend(producer Producer, message *ProducerMessage)

Modifications

Completed the comment so it reads

// BeforeSend This is called before send the message to the brokers. This method is allowed to modify the
// message.

Verifying this change

  • Make sure that the change passes the CI checks.

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/UQ4Q1MNPOpf

Does this pull request potentially affect one of the following parts:

  • Dependencies (does it add or upgrade a dependency): no
  • The public API: no
  • The schema: no
  • The default values of configurations: no
  • The wire protocol: no

Documentation

  • Does this pull request introduce a new feature? no
  • If yes, how is the feature documented? not applicable
  • If a feature is not applicable for documentation, explain why? It is the documentation.
  • If a feature is not documented yet in this PR, please create a followup issue for adding the documentation

Signed-off-by: Oliver Muir <oliver.muir@arenko.group>
Copy link
Member

@tisonkun tisonkun left a comment

Choose a reason for hiding this comment

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

Thank you!

@tisonkun tisonkun merged commit e3046f8 into apache:master Oct 24, 2023
5 of 6 checks passed
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