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/03/18 10:40:34 UTC

[GitHub] [pulsar] momo-jun opened a new pull request #14746: [enh][doc]describe message ID and enhance the description of sequence ID

momo-jun opened a new pull request #14746:
URL: https://github.com/apache/pulsar/pull/14746


   ### Modifications
   
   Fix #14455. 
   
   1. add a description for Message ID.
   2. enhance the description of Sequence ID.
   
   Preview looks good.
   <img width="1311" alt="image" src="https://user-images.githubusercontent.com/60642177/158987837-c5dbfcec-7e0f-45b7-9540-c6e1fa91a573.png">
   
   
   ### Documentation
   
   - [ ] `doc` 
   
   


-- 
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] github-actions[bot] commented on pull request #14746: [enh][doc]describe message ID and enhance the description of sequence ID

Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #14746:
URL: https://github.com/apache/pulsar/pull/14746#issuecomment-1072294978


   @momo-jun:Thanks for your contribution. For this PR, do we need to update docs?
   (The [PR template contains info about doc](https://github.com/apache/pulsar/blob/master/.github/PULL_REQUEST_TEMPLATE.md#documentation), which helps others know more about the changes. Can you provide doc-related info in this and future PR descriptions? Thanks)


-- 
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] momo-jun commented on pull request #14746: [enh][doc]describe message ID and enhance the description of sequence ID

Posted by GitBox <gi...@apache.org>.
momo-jun commented on pull request #14746:
URL: https://github.com/apache/pulsar/pull/14746#issuecomment-1072287394


   Thanks @RobertIndie for providing inputs and support.
   Hi @codelipenghui @Anonymitaet, can you pls review this PR? Thanks.


-- 
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] codelipenghui commented on a change in pull request #14746: [enh][doc]: describe message ID and enhance the description of sequence ID

Posted by GitBox <gi...@apache.org>.
codelipenghui commented on a change in pull request #14746:
URL: https://github.com/apache/pulsar/pull/14746#discussion_r829916507



##########
File path: site2/docs/concepts-messaging.md
##########
@@ -20,10 +20,11 @@ Value / data payload | The data carried by the message. All Pulsar messages cont
 Key | Messages are optionally tagged with keys, which is useful for things like [topic compaction](concepts-topic-compaction.md).
 Properties | An optional key/value map of user-defined properties.
 Producer name | The name of the producer who produces the message. If you do not specify a producer name, the default name is used. 
-Sequence ID | Each Pulsar message belongs to an ordered sequence on its topic. The sequence ID of the message is its order in that sequence.
+Sequence ID | Each Pulsar message belongs to an ordered sequence on its topic. The sequence ID of a message is assigned by its producer, indicating its order in that sequence.<br />Sequence ID can be used for message deduplication. If `brokerDeduplicationEnabled` is set to `true`, the sequence ID of each message is unique within a partition or a non-partitioned topic. 

Review comment:
       1. The sequence ID also can be assigned by users.
   2. The sequence ID of each message is unique within a producer of a topic(nong-partitioned) or a partition




-- 
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 a change in pull request #14746: [improve][doc] Describe message ID and enhance the description of sequence ID

Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on a change in pull request #14746:
URL: https://github.com/apache/pulsar/pull/14746#discussion_r831884214



##########
File path: site2/docs/concepts-messaging.md
##########
@@ -20,11 +20,12 @@ Value / data payload | The data carried by the message. All Pulsar messages cont
 Key | Messages are optionally tagged with keys, which is useful for things like [topic compaction](concepts-topic-compaction.md).
 Properties | An optional key/value map of user-defined properties.
 Producer name | The name of the producer who produces the message. If you do not specify a producer name, the default name is used. 
+Topic name | The name of the topic that the message is published to.

Review comment:
       Here is "use prepositions with relative pronouns" rather than "restrictive clause (that) vs non-restrictive clause (which)"
   
   ### Use prepositions with relative pronouns
   Prepositions (In, On, At, To) are used with relative pronouns(Which) to indicate a relationship between two clauses when referring to a particular subject. 
   eg. 
   The town to which we were driving was 50 ks away.
   This is the card to which I was referring.
   
   ### that VS which (restrictive clause )- American English
   eg. 
   Set the `service_url` to the value which is obtained through Step 1. ❌
   Set the `service_url` to the value that is obtained through Step 1. ✅
   
   "that" is used with a restrictive clause. "which" is used with a non-restrictive clause. In these cases, the information is essential to the meaning (a restrictive clause), so we should use "that".




-- 
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] codelipenghui commented on pull request #14746: [improve][doc] Describe message ID and enhance the description of sequence ID

Posted by GitBox <gi...@apache.org>.
codelipenghui commented on pull request #14746:
URL: https://github.com/apache/pulsar/pull/14746#issuecomment-1073483021


   > BTW, the TypedMessageBuilder item is an interface rather than a component of a message. Can it be moved to https://pulsar.apache.org/docs/en/next/client-libraries-java/#configure-messages or somewhere else? @codelipenghui
   
   @momo-jun Yes, correct. It's not a component of a message, it's a builder for building message instances, and in most case users do not need to use it directly, instead, users should use `producer.newMessage()` to create messages.
   
   I think we can remove it from the above table first. And looks like the table also missed some components of a message, such as https://github.com/apache/pulsar/blob/master/pulsar-client-api/src/main/java/org/apache/pulsar/client/api/Message.java#L175.


-- 
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] github-actions[bot] commented on pull request #14746: [enh][doc]describe message ID and enhance the description of sequence ID

Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #14746:
URL: https://github.com/apache/pulsar/pull/14746#issuecomment-1072305083


   @momo-jun:Thanks for providing doc info!


-- 
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] momo-jun commented on a change in pull request #14746: [improve][doc] Describe message ID and enhance the description of sequence ID

Posted by GitBox <gi...@apache.org>.
momo-jun commented on a change in pull request #14746:
URL: https://github.com/apache/pulsar/pull/14746#discussion_r831939615



##########
File path: site2/docs/concepts-messaging.md
##########
@@ -20,11 +20,12 @@ Value / data payload | The data carried by the message. All Pulsar messages cont
 Key | Messages are optionally tagged with keys, which is useful for things like [topic compaction](concepts-topic-compaction.md).
 Properties | An optional key/value map of user-defined properties.
 Producer name | The name of the producer who produces the message. If you do not specify a producer name, the default name is used. 
+Topic name | The name of the topic that the message is published to.

Review comment:
       Thanks for the clarification and I see your point. I will add your explanations to the style guide. 
   But I wonder both are correct in this case (will turn to our editors for a double-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] Anonymitaet commented on a change in pull request #14746: [improve][doc] Describe message ID and enhance the description of sequence ID

Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on a change in pull request #14746:
URL: https://github.com/apache/pulsar/pull/14746#discussion_r831718472



##########
File path: site2/docs/concepts-messaging.md
##########
@@ -20,11 +20,12 @@ Value / data payload | The data carried by the message. All Pulsar messages cont
 Key | Messages are optionally tagged with keys, which is useful for things like [topic compaction](concepts-topic-compaction.md).
 Properties | An optional key/value map of user-defined properties.
 Producer name | The name of the producer who produces the message. If you do not specify a producer name, the default name is used. 
+Topic name | The name of the topic that the message is published to.

Review comment:
       ```suggestion
   Topic name | The name of the topic to which the message is published.
   ```




-- 
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] momo-jun commented on a change in pull request #14746: [enh][doc]: describe message ID and enhance the description of sequence ID

Posted by GitBox <gi...@apache.org>.
momo-jun commented on a change in pull request #14746:
URL: https://github.com/apache/pulsar/pull/14746#discussion_r830712210



##########
File path: site2/docs/concepts-messaging.md
##########
@@ -20,10 +20,11 @@ Value / data payload | The data carried by the message. All Pulsar messages cont
 Key | Messages are optionally tagged with keys, which is useful for things like [topic compaction](concepts-topic-compaction.md).
 Properties | An optional key/value map of user-defined properties.
 Producer name | The name of the producer who produces the message. If you do not specify a producer name, the default name is used. 
-Sequence ID | Each Pulsar message belongs to an ordered sequence on its topic. The sequence ID of the message is its order in that sequence.
+Sequence ID | Each Pulsar message belongs to an ordered sequence on its topic. The sequence ID of a message is assigned by its producer, indicating its order in that sequence.<br />Sequence ID can be used for message deduplication. If `brokerDeduplicationEnabled` is set to `true`, the sequence ID of each message is unique within a partition or a non-partitioned topic. 

Review comment:
       Penghui, thanks for your clarification. The description of sequence ID has been updated. PTAL.




-- 
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 a change in pull request #14746: [improve][doc] Describe message ID and enhance the description of sequence ID

Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on a change in pull request #14746:
URL: https://github.com/apache/pulsar/pull/14746#discussion_r831884214



##########
File path: site2/docs/concepts-messaging.md
##########
@@ -20,11 +20,12 @@ Value / data payload | The data carried by the message. All Pulsar messages cont
 Key | Messages are optionally tagged with keys, which is useful for things like [topic compaction](concepts-topic-compaction.md).
 Properties | An optional key/value map of user-defined properties.
 Producer name | The name of the producer who produces the message. If you do not specify a producer name, the default name is used. 
+Topic name | The name of the topic that the message is published to.

Review comment:
       Here is "use prepositions with relative pronouns" rather than "restrictive clause (that) vs non-restrictive clause (which)"
   
   ### Use prepositions with relative pronouns
   Prepositions (In, On, At, To) are used with relative pronouns(Which) to indicate a relationship between two clauses when referring to a particular subject. 
   eg. 
   The town to which we were driving was 50 ks away.
   This is the card to which I was referring.
   
   ### that VS which (restrictive clause - American English)
   eg. 
   Set the `service_url` to the value which is obtained through Step 1. ❌
   Set the `service_url` to the value that is obtained through Step 1. ✅
   
   "that" is used with a restrictive clause. "which" is used with a non-restrictive clause. In these cases, the information is essential to the meaning (a restrictive clause), so we should use "that".




-- 
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 merged pull request #14746: [improve][doc] Describe message ID and enhance the description of sequence ID

Posted by GitBox <gi...@apache.org>.
Anonymitaet merged pull request #14746:
URL: https://github.com/apache/pulsar/pull/14746


   


-- 
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] momo-jun commented on a change in pull request #14746: [enh][doc]: describe message ID and enhance the description of sequence ID

Posted by GitBox <gi...@apache.org>.
momo-jun commented on a change in pull request #14746:
URL: https://github.com/apache/pulsar/pull/14746#discussion_r829927660



##########
File path: site2/docs/concepts-messaging.md
##########
@@ -20,10 +20,11 @@ Value / data payload | The data carried by the message. All Pulsar messages cont
 Key | Messages are optionally tagged with keys, which is useful for things like [topic compaction](concepts-topic-compaction.md).
 Properties | An optional key/value map of user-defined properties.
 Producer name | The name of the producer who produces the message. If you do not specify a producer name, the default name is used. 
-Sequence ID | Each Pulsar message belongs to an ordered sequence on its topic. The sequence ID of the message is its order in that sequence.
+Sequence ID | Each Pulsar message belongs to an ordered sequence on its topic. The sequence ID of a message is assigned by its producer, indicating its order in that sequence.<br />Sequence ID can be used for message deduplication. If `brokerDeduplicationEnabled` is set to `true`, the sequence ID of each message is unique within a partition or a non-partitioned topic. 

Review comment:
       Thanks Penghui. By saying "can be assigned by users", does it means that you can manually modify the sequence ID even if it has been auto-assigned by producers?




-- 
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] codelipenghui commented on a change in pull request #14746: [enh][doc]: describe message ID and enhance the description of sequence ID

Posted by GitBox <gi...@apache.org>.
codelipenghui commented on a change in pull request #14746:
URL: https://github.com/apache/pulsar/pull/14746#discussion_r829916507



##########
File path: site2/docs/concepts-messaging.md
##########
@@ -20,10 +20,11 @@ Value / data payload | The data carried by the message. All Pulsar messages cont
 Key | Messages are optionally tagged with keys, which is useful for things like [topic compaction](concepts-topic-compaction.md).
 Properties | An optional key/value map of user-defined properties.
 Producer name | The name of the producer who produces the message. If you do not specify a producer name, the default name is used. 
-Sequence ID | Each Pulsar message belongs to an ordered sequence on its topic. The sequence ID of the message is its order in that sequence.
+Sequence ID | Each Pulsar message belongs to an ordered sequence on its topic. The sequence ID of a message is assigned by its producer, indicating its order in that sequence.<br />Sequence ID can be used for message deduplication. If `brokerDeduplicationEnabled` is set to `true`, the sequence ID of each message is unique within a partition or a non-partitioned topic. 

Review comment:
       1. The sequence ID also can be assigned by users.
   2. The sequence ID of each message is unique within a producer of a topic(nong-partitioned) or a partition

##########
File path: site2/docs/concepts-messaging.md
##########
@@ -20,10 +20,11 @@ Value / data payload | The data carried by the message. All Pulsar messages cont
 Key | Messages are optionally tagged with keys, which is useful for things like [topic compaction](concepts-topic-compaction.md).
 Properties | An optional key/value map of user-defined properties.
 Producer name | The name of the producer who produces the message. If you do not specify a producer name, the default name is used. 
-Sequence ID | Each Pulsar message belongs to an ordered sequence on its topic. The sequence ID of the message is its order in that sequence.
+Sequence ID | Each Pulsar message belongs to an ordered sequence on its topic. The sequence ID of a message is assigned by its producer, indicating its order in that sequence.<br />Sequence ID can be used for message deduplication. If `brokerDeduplicationEnabled` is set to `true`, the sequence ID of each message is unique within a partition or a non-partitioned topic. 

Review comment:
       Yes, users can provide the custom sequence ID for a message




-- 
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] momo-jun commented on a change in pull request #14746: [improve][doc] Describe message ID and enhance the description of sequence ID

Posted by GitBox <gi...@apache.org>.
momo-jun commented on a change in pull request #14746:
URL: https://github.com/apache/pulsar/pull/14746#discussion_r831723894



##########
File path: site2/docs/concepts-messaging.md
##########
@@ -20,11 +20,12 @@ Value / data payload | The data carried by the message. All Pulsar messages cont
 Key | Messages are optionally tagged with keys, which is useful for things like [topic compaction](concepts-topic-compaction.md).
 Properties | An optional key/value map of user-defined properties.
 Producer name | The name of the producer who produces the message. If you do not specify a producer name, the default name is used. 
+Topic name | The name of the topic that the message is published to.

Review comment:
       @Anonymitaet Is it a restrictive clause and only "that" can be used? 




-- 
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] github-actions[bot] commented on pull request #14746: [enh][doc]describe message ID and enhance the description of sequence ID

Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #14746:
URL: https://github.com/apache/pulsar/pull/14746#issuecomment-1072294978






-- 
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] momo-jun commented on pull request #14746: [enh][doc]describe message ID and enhance the description of sequence ID

Posted by GitBox <gi...@apache.org>.
momo-jun commented on pull request #14746:
URL: https://github.com/apache/pulsar/pull/14746#issuecomment-1072287394


   Thanks @RobertIndie for providing inputs and support.
   Hi @codelipenghui @Anonymitaet, can you pls review this PR? Thanks.


-- 
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] codelipenghui commented on pull request #14746: [improve][doc] Describe message ID and enhance the description of sequence ID

Posted by GitBox <gi...@apache.org>.
codelipenghui commented on pull request #14746:
URL: https://github.com/apache/pulsar/pull/14746#issuecomment-1073588136


   > Does it make sense to maintain a minimum list of mandatory components in the doc?
   For example, add SchemaVersion but skip RedeliveryCount (because it is only available when msg redelivery is turned on).
   
   Make sense. The client Java doc will provide the complete list.


-- 
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] momo-jun commented on pull request #14746: [improve][doc] Describe message ID and enhance the description of sequence ID

Posted by GitBox <gi...@apache.org>.
momo-jun commented on pull request #14746:
URL: https://github.com/apache/pulsar/pull/14746#issuecomment-1073460440


   BTW, the `TypedMessageBuilder` item is an interface rather than a component of a message. Can it be moved to https://pulsar.apache.org/docs/en/next/client-libraries-java/#configure-messages or somewhere else? @codelipenghui 
   
   ![image](https://user-images.githubusercontent.com/60642177/159202855-52493d6a-677e-41de-b3cf-2be5193548b3.png)
   


-- 
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] momo-jun commented on pull request #14746: [improve][doc] Describe message ID and enhance the description of sequence ID

Posted by GitBox <gi...@apache.org>.
momo-jun commented on pull request #14746:
URL: https://github.com/apache/pulsar/pull/14746#issuecomment-1073576421


   > > BTW, the TypedMessageBuilder item is an interface rather than a component of a message. Can it be moved to https://pulsar.apache.org/docs/en/next/client-libraries-java/#configure-messages or somewhere else? @codelipenghui
   > 
   > @momo-jun Yes, correct. It's not a component of a message, it's a builder for building message instances, and in most case users do not need to use it directly, instead, users should use `producer.newMessage()` to create messages.
   > 
   > I think we can remove it from the above table first. And looks like the table also missed some components of a message, such as https://github.com/apache/pulsar/blob/master/pulsar-client-api/src/main/java/org/apache/pulsar/client/api/Message.java#L175.
   
   @codelipenghui Seems there were quite a few advanced and optional components added in the latest releases. And it will be a dynamic and long list if we keep adding more features in the coming releases.
   Does it make sense to maintain a minimum list of mandatory components in the doc? 
   For example, add `SchemaVersion` but skip `RedeliveryCount` (because it is only available when msg redelivery is turned on).
   


-- 
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 a change in pull request #14746: [improve][doc] Describe message ID and enhance the description of sequence ID

Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on a change in pull request #14746:
URL: https://github.com/apache/pulsar/pull/14746#discussion_r831884214



##########
File path: site2/docs/concepts-messaging.md
##########
@@ -20,11 +20,12 @@ Value / data payload | The data carried by the message. All Pulsar messages cont
 Key | Messages are optionally tagged with keys, which is useful for things like [topic compaction](concepts-topic-compaction.md).
 Properties | An optional key/value map of user-defined properties.
 Producer name | The name of the producer who produces the message. If you do not specify a producer name, the default name is used. 
+Topic name | The name of the topic that the message is published to.

Review comment:
       Here is "use prepositions with relative pronouns" rather than "restrictive clause (that) vs non-restrictive clause (which) - American English"
   
   ### Use prepositions with relative pronouns
   Prepositions (In, On, At, To) are used with relative pronouns(Which) to indicate a relationship between two clauses when referring to a particular subject. 
   eg. 
   The town to which we were driving was 50 ks away.
   This is the card to which I was referring.
   
   ### that VS which (restrictive clause - American English)
   eg. 
   Set the `service_url` to the value which is obtained through Step 1. ❌
   Set the `service_url` to the value that is obtained through Step 1. ✅
   
   "that" is used with a restrictive clause. "which" is used with a non-restrictive clause. In these cases, the information is essential to the meaning (a restrictive clause), so we should use "that".




-- 
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 a change in pull request #14746: [improve][doc] Describe message ID and enhance the description of sequence ID

Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on a change in pull request #14746:
URL: https://github.com/apache/pulsar/pull/14746#discussion_r831964472



##########
File path: site2/docs/concepts-messaging.md
##########
@@ -20,11 +20,12 @@ Value / data payload | The data carried by the message. All Pulsar messages cont
 Key | Messages are optionally tagged with keys, which is useful for things like [topic compaction](concepts-topic-compaction.md).
 Properties | An optional key/value map of user-defined properties.
 Producer name | The name of the producer who produces the message. If you do not specify a producer name, the default name is used. 
+Topic name | The name of the topic that the message is published to.

Review comment:
       OK, thanks.




-- 
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] momo-jun commented on a change in pull request #14746: [enh][doc]: describe message ID and enhance the description of sequence ID

Posted by GitBox <gi...@apache.org>.
momo-jun commented on a change in pull request #14746:
URL: https://github.com/apache/pulsar/pull/14746#discussion_r829927660



##########
File path: site2/docs/concepts-messaging.md
##########
@@ -20,10 +20,11 @@ Value / data payload | The data carried by the message. All Pulsar messages cont
 Key | Messages are optionally tagged with keys, which is useful for things like [topic compaction](concepts-topic-compaction.md).
 Properties | An optional key/value map of user-defined properties.
 Producer name | The name of the producer who produces the message. If you do not specify a producer name, the default name is used. 
-Sequence ID | Each Pulsar message belongs to an ordered sequence on its topic. The sequence ID of the message is its order in that sequence.
+Sequence ID | Each Pulsar message belongs to an ordered sequence on its topic. The sequence ID of a message is assigned by its producer, indicating its order in that sequence.<br />Sequence ID can be used for message deduplication. If `brokerDeduplicationEnabled` is set to `true`, the sequence ID of each message is unique within a partition or a non-partitioned topic. 

Review comment:
       Thanks Penghui. By saying "can be assigned by users", does it means that you can manually modify the sequence ID even if it has been auto-assigned by producers?




-- 
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] codelipenghui commented on a change in pull request #14746: [enh][doc]: describe message ID and enhance the description of sequence ID

Posted by GitBox <gi...@apache.org>.
codelipenghui commented on a change in pull request #14746:
URL: https://github.com/apache/pulsar/pull/14746#discussion_r830040667



##########
File path: site2/docs/concepts-messaging.md
##########
@@ -20,10 +20,11 @@ Value / data payload | The data carried by the message. All Pulsar messages cont
 Key | Messages are optionally tagged with keys, which is useful for things like [topic compaction](concepts-topic-compaction.md).
 Properties | An optional key/value map of user-defined properties.
 Producer name | The name of the producer who produces the message. If you do not specify a producer name, the default name is used. 
-Sequence ID | Each Pulsar message belongs to an ordered sequence on its topic. The sequence ID of the message is its order in that sequence.
+Sequence ID | Each Pulsar message belongs to an ordered sequence on its topic. The sequence ID of a message is assigned by its producer, indicating its order in that sequence.<br />Sequence ID can be used for message deduplication. If `brokerDeduplicationEnabled` is set to `true`, the sequence ID of each message is unique within a partition or a non-partitioned topic. 

Review comment:
       Yes, users can provide the custom sequence ID for a message




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