修复 docs/v2/zh/docs/harness/memory.md 文档描述错误 - #3232
xin-xin-obj wants to merge 1 commit into
Conversation
## 问题说明 原文档描述：`disableMemoryHooks()` 是核选项 ## 修改内容 - 修改 `disableMemoryHooks()` 是可选项
|
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
oss-maintainer
left a comment
oss-maintainer
left a comment
There was a problem hiding this comment.
Summary
Thanks for the docs fix, @xin-xin-obj — and for the clear PR description. One thing though: the 核选项 wording looks intentional rather than a typo. It translates the English page (docs/v2/en/docs/harness/memory.md:268), which calls .disableMemoryHooks() "the nuclear option for background memory work", and the surrounding text (关掉 flush + 后台维护, "两者一起用时还会跳过 <memory_context> 注入") really does describe an all-or-nothing switch. Changing it to 可选项 would flip the meaning of the sentence and desync the ZH page from EN. Details in the inline comment. Leaving this to the maintainers to weigh in.
Automated review by github-manager-bot
| 两者一起用时，还会跳过 `<memory_context>`（`MEMORY.md`）注入，但保留 Domain Knowledge / AGENTS / knowledge 上下文。 | ||
|
|
||
| `disableMemoryHooks()` 是核选项；只想节流不想关，用 `.memory(MemoryConfig.builder().flushTrigger(...).build())`。 | ||
| `disableMemoryHooks()` 是可选项；只想节流不想关，用 `.memory(MemoryConfig.builder().flushTrigger(...).build())`。 |
There was a problem hiding this comment.
This sentence is a deliberate translation of the English doc, not a typo. The English page at docs/v2/en/docs/harness/memory.md:268 reads:
disableMemoryHooks()is the nuclear option for background memory work; if you only want to throttle, use.memory(MemoryConfig.builder().flushTrigger(...).build())instead.
核选项 renders "nuclear option" (i.e. the drastic, all-or-nothing switch). Changing it to 可选项 ("an optional choice") reverses the meaning: the whole section is warning users that this call disables flush and background maintenance at once, and the second half of the sentence (只想节流不想关 — "if you only want to throttle...") only makes sense as a contrast against a heavyweight switch. As 可选项 the sentence no longer conveys a trade-off and would read as odd to native speakers.
If 核选项 feels too literal, a more natural rendering that keeps the original intent would be disableMemoryHooks() 是「一刀切」的总开关 — but as it stands I'd suggest keeping the current wording so the ZH and EN pages stay in sync.
Happy to re-review if you retarget the PR at a different phrasing or find another wording issue in this file.
|
感谢贡献，不过这种逐字较真没必要 |
4 participants
问题说明
原文档描述：
disableMemoryHooks()是核选项修改内容
disableMemoryHooks()是可选项AgentScope-Java Version
v2
Description
修改doc文档文本描述错误
Checklist
Please check the following items before code is ready to be reviewed.
mvn spotless:applymvn test)