You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2022/08/26 09:13:11 UTC
[GitHub] [pulsar] coderzc opened a new pull request, #17296: [improve]Use Text Blocks improve too long string in ServiceConfiguration doc annotation
coderzc opened a new pull request, #17296:
URL: https://github.com/apache/pulsar/pull/17296
### Motivation
I found that there are many long strings joined in ServiceConfiguration doc annotation, we can use [Text Blocks](https://docs.oracle.com/en/java/javase/15/text-blocks/index.html) to improve readability.
### Modifications
use Text Blocks instead of long strings joined.
### Documentation
Check the box below or label this PR directly.
Need to update docs?
- [ ] `doc-required`
(Your PR needs to update docs and you will update later)
- [ ] `doc-not-needed`
(Please explain why)
- [x] `doc`
(Your PR contains doc changes)
- [ ] `doc-complete`
(Docs have been already added)
--
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
[GitHub] [pulsar] tisonkun commented on a diff in pull request #17296: [improve][doc] Use Text Blocks improve too long string in ServiceConfiguration doc annotation
Posted by 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
[GitHub] [pulsar] tisonkun commented on a diff in pull request #17296: [improve][doc] Use Text Blocks improve too long string in ServiceConfiguration doc annotation
Posted by GitBox <gi...@apache.org>.
tisonkun commented on code in PR #17296:
URL: https://github.com/apache/pulsar/pull/17296#discussion_r967588640
##########
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"""
Review Comment:
```suggestion
doc = "The metadata store URL for the configuration data. If empty, we fall back to use metadataStoreUrl"
```
Revert. No need to change.
--
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
[GitHub] [pulsar] coderzc commented on a diff in pull request #17296: [improve][doc] Use Text Blocks improve too long string in ServiceConfiguration doc annotation
Posted by GitBox <gi...@apache.org>.
coderzc commented on code in PR #17296:
URL: https://github.com/apache/pulsar/pull/17296#discussion_r967579672
##########
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:
Also can fully left justify a wide string in order to avoid horizontal scrolling or line wrapping, see: https://docs.oracle.com/en/java/javase/15/text-blocks/index.html#style-guidelines-for-text-blocks G10
--
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
[GitHub] [pulsar] tisonkun commented on a diff in pull request #17296: [improve][doc] Use Text Blocks improve too long string in ServiceConfiguration doc annotation
Posted by GitBox <gi...@apache.org>.
tisonkun commented on code in PR #17296:
URL: https://github.com/apache/pulsar/pull/17296#discussion_r967589245
##########
pulsar-broker-common/src/main/java/org/apache/pulsar/broker/ServiceConfiguration.java:
##########
@@ -195,15 +201,18 @@ public class ServiceConfiguration implements PulsarConfiguration {
@FieldContext(
category = CATEGORY_TLS,
- doc = "Specify the tls protocols the proxy's web service will use to negotiate during TLS Handshake.\n\n"
- + "Example:- [TLSv1.3, TLSv1.2]"
+ doc = """
+ Specify the tls protocols the proxy's web service will use to negotiate during TLS Handshake.
+
+ Example:- [TLSv1.3, TLSv1.2]"""
)
private Set<String> webServiceTlsProtocols = new TreeSet<>();
@FieldContext(
category = CATEGORY_TLS,
- doc = "Specify the tls cipher the proxy's web service will use to negotiate during TLS Handshake.\n\n"
- + "Example:- [TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256]"
+ doc = """
+ Specify the tls cipher the proxy's web service will use to negotiate during TLS Handshake.
+ Example:- [TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256]"""
Review Comment:
Both sections have `\n\n` but you translate the first into one `\n` while the section into two `\n`s. Either works but please keep concistent.
--
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
[GitHub] [pulsar] coderzc commented on a diff in pull request #17296: [improve][doc] Use Text Blocks improve too long string in ServiceConfiguration doc annotation
Posted by GitBox <gi...@apache.org>.
coderzc commented on code in PR #17296:
URL: https://github.com/apache/pulsar/pull/17296#discussion_r967576457
##########
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:
I think it is more readable than strings joined, maybe we can by adding a line break after `.` to reduce the use of ` \ `.
--
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
[GitHub] [pulsar] coderzc commented on a diff in pull request #17296: [improve][doc] Use Text Blocks improve too long string in ServiceConfiguration doc annotation
Posted by GitBox <gi...@apache.org>.
coderzc commented on code in PR #17296:
URL: https://github.com/apache/pulsar/pull/17296#discussion_r967601822
##########
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:
Ok, I will only leave which multi-line string and include escape character changes.
--
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
[GitHub] [pulsar] Jason918 commented on a diff in pull request #17296: [improve][doc] Use Text Blocks improve too long string in ServiceConfiguration doc annotation
Posted by GitBox <gi...@apache.org>.
Jason918 commented on code in PR #17296:
URL: https://github.com/apache/pulsar/pull/17296#discussion_r967572790
##########
pulsar-broker-common/src/main/java/org/apache/pulsar/broker/ServiceConfiguration.java:
##########
@@ -1931,33 +2077,37 @@ public class ServiceConfiguration implements PulsarConfiguration {
private int managedLedgerCursorRolloverTimeInSeconds = 14400;
@FieldContext(
category = CATEGORY_STORAGE_ML,
- doc = "Max number of `acknowledgment holes` that are going to be persistently stored.\n\n"
- + "When acknowledging out of order, a consumer will leave holes that are supposed"
- + " to be quickly filled by acking all the messages. The information of which"
- + " messages are acknowledged is persisted by compressing in `ranges` of messages"
- + " that were acknowledged. After the max number of ranges is reached, the information"
- + " will only be tracked in memory and messages will be redelivered in case of"
- + " crashes.")
+ doc = """
+ Max number of `acknowledgment holes` that are going to be persistently stored.
+
+ When acknowledging out of order, a consumer will leave holes that are supposed\
+ to be quickly filled by acking all the messages. The information of which\
Review Comment:
Better put the fist space at the end of previous line.
--
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
[GitHub] [pulsar] Anonymitaet commented on pull request #17296: [improve]Use Text Blocks improve too long string in ServiceConfiguration doc annotation
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on PR #17296:
URL: https://github.com/apache/pulsar/pull/17296#issuecomment-1229653874
@Technoboy-
could you please review this PR from the technical perspective? Thank you!
--
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
[GitHub] [pulsar] tisonkun commented on pull request #17296: [improve][doc] Use Text Blocks improve too long string in ServiceConfiguration doc annotation
Posted by GitBox <gi...@apache.org>.
tisonkun commented on PR #17296:
URL: https://github.com/apache/pulsar/pull/17296#issuecomment-1242606336
> could you please review this PR from the technical perspective? Thank you!
This patch should not change any word but only reformatting.
--
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
[GitHub] [pulsar] coderzc commented on a diff in pull request #17296: [improve][doc] Use Text Blocks improve too long string in ServiceConfiguration doc annotation
Posted by GitBox <gi...@apache.org>.
coderzc commented on code in PR #17296:
URL: https://github.com/apache/pulsar/pull/17296#discussion_r967601361
##########
pulsar-broker-common/src/main/java/org/apache/pulsar/broker/ServiceConfiguration.java:
##########
@@ -195,15 +201,18 @@ public class ServiceConfiguration implements PulsarConfiguration {
@FieldContext(
category = CATEGORY_TLS,
- doc = "Specify the tls protocols the proxy's web service will use to negotiate during TLS Handshake.\n\n"
- + "Example:- [TLSv1.3, TLSv1.2]"
+ doc = """
+ Specify the tls protocols the proxy's web service will use to negotiate during TLS Handshake.
+
+ Example:- [TLSv1.3, TLSv1.2]"""
)
private Set<String> webServiceTlsProtocols = new TreeSet<>();
@FieldContext(
category = CATEGORY_TLS,
- doc = "Specify the tls cipher the proxy's web service will use to negotiate during TLS Handshake.\n\n"
- + "Example:- [TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256]"
+ doc = """
+ Specify the tls cipher the proxy's web service will use to negotiate during TLS Handshake.
+ Example:- [TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256]"""
Review Comment:
Ok.
--
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
[GitHub] [pulsar] coderzc closed pull request #17296: [improve][doc] Use Text Blocks improve multi-line string in ServiceConfiguration doc annotation
Posted by GitBox <gi...@apache.org>.
coderzc closed pull request #17296: [improve][doc] Use Text Blocks improve multi-line string in ServiceConfiguration doc annotation
URL: https://github.com/apache/pulsar/pull/17296
--
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
[GitHub] [pulsar] tisonkun commented on a diff in pull request #17296: [improve][doc] Use Text Blocks improve multi-line string in ServiceConfiguration doc annotation
Posted by GitBox <gi...@apache.org>.
tisonkun commented on code in PR #17296:
URL: https://github.com/apache/pulsar/pull/17296#discussion_r967614142
##########
pulsar-broker-common/src/main/java/org/apache/pulsar/broker/ServiceConfiguration.java:
##########
@@ -2338,7 +2424,7 @@ public class ServiceConfiguration implements PulsarConfiguration {
doc = "Supported algorithms name for namespace bundle split"
)
private List<String> supportedNamespaceBundleSplitAlgorithms = Lists.newArrayList("range_equally_divide",
- "topic_count_equally_divide", "specified_positions_divide", "flow_or_qps_equally_divide");
+ "topic_count_equally_divide", "specified_positions_divide");
@FieldContext(
Review Comment:
ditto
##########
pulsar-broker-common/src/main/java/org/apache/pulsar/broker/ServiceConfiguration.java:
##########
@@ -595,21 +601,23 @@ public class ServiceConfiguration implements PulsarConfiguration {
@FieldContext(
category = CATEGORY_POLICIES,
dynamic = true,
- doc = "Set the inactive topic delete mode. Default is delete_when_no_subscriptions\n"
- + "'delete_when_no_subscriptions' mode only delete the topic which has no subscriptions and no active "
- + "producers\n"
- + "'delete_when_subscriptions_caught_up' mode only delete the topic that all subscriptions has no "
- + "backlogs(caught up) and no active producers/consumers"
+ doc = """
+ Set the inactive topic delete mode. Default is delete_when_no_subscriptions\
+ 'delete_when_no_subscriptions' mode only delete the topic which has no subscriptions and no active \
+ producers
+ 'delete_when_subscriptions_caught_up' mode only delete the topic that all subscriptions has no \
+ backlogs(caught up) and no active producers/consumers"""
Review Comment:
```suggestion
doc = """
Set the inactive topic delete mode. Default is delete_when_no_subscriptions.
'delete_when_no_subscriptions' mode only delete the topic which has no subscriptions
and no active producers;
'delete_when_subscriptions_caught_up' mode only delete the topic that all subscriptions has no
backlogs(caught up) and no active producers/consumers"""
```
##########
pulsar-broker-common/src/main/java/org/apache/pulsar/broker/ServiceConfiguration.java:
##########
@@ -572,17 +576,19 @@ public class ServiceConfiguration implements PulsarConfiguration {
@FieldContext(
category = CATEGORY_POLICIES,
dynamic = true,
- doc = "Enable the deletion of inactive topics.\n"
- + "If only enable this option, will not clean the metadata of partitioned topic."
+ doc = """
+ Enable the deletion of inactive topics.
+ If only enable this option, will not clean the metadata of partitioned topic."""
)
private boolean brokerDeleteInactiveTopicsEnabled = true;
@FieldContext(
category = CATEGORY_POLICIES,
dynamic = true,
- doc = "Metadata of inactive partitioned topic will not be automatically cleaned up by default.\n"
- + "Note: If `allowAutoTopicCreation` and this option are enabled at the same time,\n"
- + "it may appear that a partitioned topic has just been deleted but is automatically created as a "
- + "non-partitioned topic."
+ doc = """
+ Metadata of inactive partitioned topic will not be automatically cleaned up by default.
+ Note: If `allowAutoTopicCreation` and this option are enabled at the same time, \
+ it may appear that a partitioned topic has just been deleted but is automatically created as a \
+ non-partitioned topic."""
Review Comment:
```suggestion
doc = """
Metadata of inactive partitioned topic will not be automatically cleaned up by default.
Note: If `allowAutoTopicCreation` and this option are enabled at the same time,
it may appear that a partitioned topic has just been deleted but is automatically created as a
non-partitioned topic."""
```
##########
pulsar-broker-common/src/main/java/org/apache/pulsar/broker/ServiceConfiguration.java:
##########
@@ -2160,19 +2259,6 @@ public class ServiceConfiguration implements PulsarConfiguration {
)
private int loadBalancerAverageResourceUsageDifferenceThresholdPercentage = 10;
-
- @FieldContext(
- dynamic = true,
- category = CATEGORY_LOAD_BALANCER,
- doc = "In FlowOrQpsEquallyDivideBundleSplitAlgorithm,"
- + " if msgRate >= loadBalancerNamespaceBundleMaxMsgRate * "
- + " (100 + flowOrQpsDifferenceThresholdPercentage)/100.0 "
- + " or throughput >= loadBalancerNamespaceBundleMaxBandwidthMbytes * "
- + " (100 + flowOrQpsDifferenceThresholdPercentage)/100.0, "
- + " execute split bundle"
- )
- private int flowOrQpsDifferenceThresholdPercentage = 10;
Review Comment:
Please avoid mixing code refactor/cleanup into a reformatting change.
##########
pulsar-broker-common/src/main/java/org/apache/pulsar/broker/ServiceConfiguration.java:
##########
@@ -595,21 +601,23 @@ public class ServiceConfiguration implements PulsarConfiguration {
@FieldContext(
category = CATEGORY_POLICIES,
dynamic = true,
- doc = "Set the inactive topic delete mode. Default is delete_when_no_subscriptions\n"
- + "'delete_when_no_subscriptions' mode only delete the topic which has no subscriptions and no active "
- + "producers\n"
- + "'delete_when_subscriptions_caught_up' mode only delete the topic that all subscriptions has no "
- + "backlogs(caught up) and no active producers/consumers"
+ doc = """
+ Set the inactive topic delete mode. Default is delete_when_no_subscriptions\
+ 'delete_when_no_subscriptions' mode only delete the topic which has no subscriptions and no active \
+ producers
+ 'delete_when_subscriptions_caught_up' mode only delete the topic that all subscriptions has no \
+ backlogs(caught up) and no active producers/consumers"""
)
private InactiveTopicDeleteMode brokerDeleteInactiveTopicsMode = InactiveTopicDeleteMode.
delete_when_no_subscriptions;
@FieldContext(
category = CATEGORY_POLICIES,
dynamic = true,
- doc = "Max duration of topic inactivity in seconds, default is not present\n"
- + "If not present, 'brokerDeleteInactiveTopicsFrequencySeconds' will be used\n"
- + "Topics that are inactive for longer than this value will be deleted"
+ doc = """
+ Max duration of topic inactivity in seconds, default is not present \
+ If not present, 'brokerDeleteInactiveTopicsFrequencySeconds' will be used \
+ Topics that are inactive for longer than this value will be deleted"""
Review Comment:
```suggestion
doc = """
Max duration of topic inactivity in seconds, default is not present
If not present, 'brokerDeleteInactiveTopicsFrequencySeconds' will be used
Topics that are inactive for longer than this value will be deleted"""
```
--
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
[GitHub] [pulsar] Jason918 commented on a diff in pull request #17296: [improve][doc] Use Text Blocks improve too long string in ServiceConfiguration doc annotation
Posted by GitBox <gi...@apache.org>.
Jason918 commented on code in PR #17296:
URL: https://github.com/apache/pulsar/pull/17296#discussion_r967572684
##########
pulsar-broker-common/src/main/java/org/apache/pulsar/broker/ServiceConfiguration.java:
##########
@@ -1886,12 +2030,13 @@ public class ServiceConfiguration implements PulsarConfiguration {
@FieldContext(
category = CATEGORY_STORAGE_ML,
- doc = "Max number of entries to append to a ledger before triggering a rollover.\n\n"
- + "A ledger rollover is triggered after the min rollover time has passed"
- + " and one of the following conditions is true:"
- + " the max rollover time has been reached,"
- + " the max entries have been written to the ledger, or"
- + " the max ledger size has been written to the ledger")
+ doc = """
+ Max number of entries to append to a ledger before triggering a rollover.
+ A ledger rollover is triggered after the min rollover time has passed\
+ and one of the following conditions is true:\
+ the max rollover time has been reached,\
+ the max entries have been written to the ledger, or\
+ the max ledger size has been written to the ledger""")
Review Comment:
```suggestion
A ledger rollover is triggered after the min rollover time has passed \
and one of the following conditions is true: \
the max rollover time has been reached, \
the max entries have been written to the ledger, or \
the max ledger size has been written to the ledger""")
```
--
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
[GitHub] [pulsar] Jason918 commented on a diff in pull request #17296: [improve][doc] Use Text Blocks improve too long string in ServiceConfiguration doc annotation
Posted by GitBox <gi...@apache.org>.
Jason918 commented on code in PR #17296:
URL: https://github.com/apache/pulsar/pull/17296#discussion_r967572348
##########
pulsar-broker-common/src/main/java/org/apache/pulsar/broker/ServiceConfiguration.java:
##########
@@ -1702,15 +1839,17 @@ public class ServiceConfiguration implements PulsarConfiguration {
@FieldContext(category = CATEGORY_STORAGE_BK, doc = "Path for the trusted TLS certificate file")
private String bookkeeperTLSTrustCertsFilePath;
- @FieldContext(category = CATEGORY_STORAGE_BK, doc = "Tls cert refresh duration at bookKeeper-client in seconds (0 "
- + "to disable check)")
+ @FieldContext(category = CATEGORY_STORAGE_BK, doc = """
+ Tls cert refresh duration at bookKeeper-client in seconds (0to disable check)
Review Comment:
```suggestion
Tls cert refresh duration at bookKeeper-client in seconds (0 to disable check)
```
--
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
[GitHub] [pulsar] coderzc commented on a diff in pull request #17296: [improve][doc] Use Text Blocks improve multi-line string in ServiceConfiguration doc annotation
Posted by GitBox <gi...@apache.org>.
coderzc commented on code in PR #17296:
URL: https://github.com/apache/pulsar/pull/17296#discussion_r967601361
##########
pulsar-broker-common/src/main/java/org/apache/pulsar/broker/ServiceConfiguration.java:
##########
@@ -195,15 +201,18 @@ public class ServiceConfiguration implements PulsarConfiguration {
@FieldContext(
category = CATEGORY_TLS,
- doc = "Specify the tls protocols the proxy's web service will use to negotiate during TLS Handshake.\n\n"
- + "Example:- [TLSv1.3, TLSv1.2]"
+ doc = """
+ Specify the tls protocols the proxy's web service will use to negotiate during TLS Handshake.
+
+ Example:- [TLSv1.3, TLSv1.2]"""
)
private Set<String> webServiceTlsProtocols = new TreeSet<>();
@FieldContext(
category = CATEGORY_TLS,
- doc = "Specify the tls cipher the proxy's web service will use to negotiate during TLS Handshake.\n\n"
- + "Example:- [TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256]"
+ doc = """
+ Specify the tls cipher the proxy's web service will use to negotiate during TLS Handshake.
+ Example:- [TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256]"""
Review Comment:
Ok, thanks. I will improve it.
--
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
[GitHub] [pulsar] coderzc commented on a diff in pull request #17296: [improve][doc] Use Text Blocks improve too long string in ServiceConfiguration doc annotation
Posted by GitBox <gi...@apache.org>.
coderzc commented on code in PR #17296:
URL: https://github.com/apache/pulsar/pull/17296#discussion_r967573218
##########
pulsar-broker-common/src/main/java/org/apache/pulsar/broker/ServiceConfiguration.java:
##########
@@ -1931,33 +2077,37 @@ public class ServiceConfiguration implements PulsarConfiguration {
private int managedLedgerCursorRolloverTimeInSeconds = 14400;
@FieldContext(
category = CATEGORY_STORAGE_ML,
- doc = "Max number of `acknowledgment holes` that are going to be persistently stored.\n\n"
- + "When acknowledging out of order, a consumer will leave holes that are supposed"
- + " to be quickly filled by acking all the messages. The information of which"
- + " messages are acknowledged is persisted by compressing in `ranges` of messages"
- + " that were acknowledged. After the max number of ranges is reached, the information"
- + " will only be tracked in memory and messages will be redelivered in case of"
- + " crashes.")
+ doc = """
+ Max number of `acknowledgment holes` that are going to be persistently stored.
+
+ When acknowledging out of order, a consumer will leave holes that are supposed\
+ to be quickly filled by acking all the messages. The information of which\
Review Comment:
Ok. I will improve it.
--
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
[GitHub] [pulsar] tisonkun commented on a diff in pull request #17296: [improve][doc] Use Text Blocks improve too long string in ServiceConfiguration doc annotation
Posted by GitBox <gi...@apache.org>.
tisonkun commented on code in PR #17296:
URL: https://github.com/apache/pulsar/pull/17296#discussion_r967588492
##########
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:
The original string context is not "strings joined", it's "strings concatenation". So, please leave the content as is.
If you'd like to add a newline by using textblock. I don't have a strong feeling here. Do as you like.
To sum up, either:
1. Revert the change;
2. Remove `\`.
is OK for me. `\` doesn't work because we do a simple thing more complex.
--
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