[GitHub] [pulsar] tisonkun commented on a diff in pull request #17296: [improve][doc] Use Text Blocks improve too long string in ServiceConfiguration doc annotation

[GitBox <gi...@apache.org>]

tisonkun commented on code in PR #17296:
URL: https://github.com/apache/pulsar/pull/17296#discussion_r967573208


##########
pulsar-broker-common/src/main/java/org/apache/pulsar/broker/ServiceConfiguration.java:
##########
@@ -158,22 +161,25 @@ public class ServiceConfiguration implements PulsarConfiguration {
     @FieldContext(
             category = CATEGORY_SERVER,
             required = false,
-            doc = "The metadata store URL for the configuration data. If empty, we fall back to use metadataStoreUrl"
+            doc = """
+                    The metadata store URL for the configuration data. If empty, we fall back to use metadataStoreUrl"""
     )
     private String configurationMetadataStoreUrl;
 
     @FieldContext(
         category = CATEGORY_SERVER,
-        doc = "The port for serving binary protobuf requests."
-            + " If set, defines a server binding for bindAddress:brokerServicePort."
-            + " The Default value is 6650."
+        doc = """
+             The port for serving binary protobuf requests. \
+             If set, defines a server binding for bindAddress:brokerServicePort. \
+             The Default value is 6650."""

Review Comment:
   If we need a `\` to escape line break here, I don't think it's a good fit to use text block. Ditto others.
   
   For those who need a pre-formatted doc string, text blocks can be nice.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org