Minor improvements for servicetalk-opentracing-zipkin-publisher
#1019
Conversation
This file contains 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
Motivation: `servicetalk-opentracing-zipkin-publisher` has a few things that can be improved. Modifications: - Make `LoggingReporter.Builder.loggerName` variable final; - Add javadoc for `LoggingReporter.Builder`; - Make `UdpReporter.buildBootstrap` static; - Remove info about default value from `UdpReporter.Builder.ioExecutor` javadoc;
idelpivnitskiy
commented
Apr 16, 2020
| @@ -139,8 +138,7 @@ public Builder codec(Codec codec) { | |||
| } | |||
|
|
|||
| /** | |||
| * Sets an {@link IoExecutor} to use for writing to the datagram channel. Defaults to the | |||
| * {@link GlobalExecutionContext} {@link IoExecutor}. | |||
| * Sets an {@link IoExecutor} to use for writing to the datagram channel. | |||
There was a problem hiding this comment.
We usually do not clarify default values in javadoc. Removed it to avoid referencing internal class from the public javadoc.
Scottmitch
approved these changes
Apr 16, 2020
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.
Motivation:
servicetalk-opentracing-zipkin-publisherhas a few things thatcan be improved.
Modifications:
LoggingReporter.Builder.loggerNamevariable final;LoggingReporter.Builder;UdpReporter.buildBootstrapstatic;UdpReporter.Builder.ioExecutorjavadoc;