chennaji9 opened a new issue, #11316:
URL: https://github.com/apache/rocketmq/issues/11316
### Description
Two factual errors in the `DefaultMQProducer` API reference pages
(`docs/en/client/java/API_Reference_DefaultMQProducer.md`,
`docs/cn/client/java/API_Reference_DefaultMQProducer.md`):
1. **Retry counts described as total attempts.** The property tables say
`retryTimesWhenSendFailed` / `retryTimesWhenSendAsyncFailed` are the "Maximum
number of internal attempts to send a message" (en) / "内部尝试发送消息的最大次数" (cn). In
the code the synchronous loop runs `timesTotal = 1 +
getRetryTimesWhenSendFailed()` (`DefaultMQProducerImpl.java:756`), and the
field Javadoc says "Maximum number of retry to perform internally before
claiming sending failure". With the default value 2 a sync send performs up to
**3** attempts, not 2. The field sections of the same cn page already state
this correctly ("默认值：2，即：默认情况下一条消息最多会被投递3次"), so the tables contradict the page
itself.
2. **Queue offsets called "physical offsets"** (cn page,
`maxOffset`/`minOffset`/`searchOffset` sections): these client APIs are served
by the broker's `getMaxOffsetInQueue` / `getMinOffsetInQueue` /
`getOffsetInQueueByTime` (`AdminBrokerProcessor.java:1320/1388`) and return the
consume-queue **logical** offset (message index), not a CommitLog physical byte
offset. Describing them as 物理偏移量 misleads users into comparing them with
CommitLog positions.
### Expected behavior
The tables should describe the two settings as retry counts (total attempts
= 1 + value), matching the code and the same page's field sections, and the
offset methods should be described as queue logical offsets.
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
