Repository navigation
Conversation
…r compaction topic The walkthrough runs updateTopic with -o true (compaction topics rely on ordered delivery), but the sample TopicConfig output in both language pages still said order=false.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #11350 +/- ##
=============================================
- Coverage 49.75% 49.74% -0.02%
- Complexity 14354 14371 +17
=============================================
Files 1390 1390
Lines 103246 103262 +16
Branches 13502 13504 +2
=============================================
- Hits 51375 51369 -6
- Misses 45679 45697 +18
- Partials 6192 6196 +4 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
RockteMQ-AI
left a comment
There was a problem hiding this comment.
Review by github-manager-bot
Summary
Fixes the sample TopicConfig output in the Compaction Topic walkthrough (both EN and CN) to show order=true instead of order=false, matching the -o true flag in the command above.
Findings
- [Info]
docs/en/Example_Compaction_Topic.md:15— Correct fix. TheupdateTopic -o truecommand sets order to true, so the sample output must reflect that. The original was misleading. - [Info]
docs/cn/Example_Compaction_Topic_cn.md:16— CN version is consistent with the EN change.
Suggestions
No issues found. Clean, minimal fix.
LGTM — documentation-only change, output now matches the command flag.
Automated review by github-manager-bot
|
Issue Evaluation Category: The documentation inconsistency is valid. The Root Cause: Stale sample output that was not updated when the command was written. The proposed fix (updating 2 lines in Automated evaluation by github-manager-bot |
6d3e8a6 to
2fb5f76
Compare
|
Hi @RongtongJin, sorry for the ping — this PR has been open for a while without a review yet. The change is small and focused (sample output must show order=true for compaction topic), and all tests and CI pass on my side. Would you mind taking a look when you get a chance? If it looks good, merging it would be much appreciated — happy to adjust anything if needed. Thanks a lot! |
Which Issue(s) This PR Fixes
Fixes #11333
Brief Description
The compaction-topic walkthrough (both
docs/en/Example_Compaction_Topic.mdanddocs/cn/Example_Compaction_Topic_cn.md) runsbin/mqadmin updateTopic ... -t ctopic -o true -c DefaultClusterbut the sample
TopicConfigoutput printed directly beneath saysorder=false.-oisupdateTopic's order flag (UpdateTopicSubCommand:new Option("o", "order", true, "set topic's order(true|false)")), so the shown command creates an ordered topic — and ordering is the whole point here, since the same page's first section states compaction topics rely onorderMessageEnablefor consistency. The stale output line now saysorder=truein both languages (2 lines total).How Did You Test This Change?
Documentation-only change, verified statically:
-osemantics confirmed fromUpdateTopicSubCommand.javaat the PR base commit; sample-output line matches the command's flag (order=true); no otherorder=claims exist on these pages (grep).