Skip to content

docs: clarify enableThinking example comment#1394

Open
JGoP-L wants to merge 1 commit into
agentscope-ai:mainfrom
JGoP-L:docs/clarify-enable-thinking-comment
Open

docs: clarify enableThinking example comment#1394
JGoP-L wants to merge 1 commit into
agentscope-ai:mainfrom
JGoP-L:docs/clarify-enable-thinking-comment

Conversation

@JGoP-L
Copy link
Copy Markdown
Contributor

@JGoP-L JGoP-L commented May 15, 2026

AgentScope-Java Version

1.0.13-SNAPSHOT

Description

Fixes #1393.

Background

The DashScope thinking mode example comment described .enableThinking(true) only as automatically enabling streaming. This was incomplete because the primary behavior is enabling thinking mode, while streaming is also enabled implicitly by the current implementation.

Changes

  • Clarified the Chinese docs comment for .enableThinking(true).
  • Applied the same clarification to the English docs.
  • Kept the comment aligned with the implementation: thinking mode is enabled and streaming is automatically enabled.

How to test

Verified the updated comments in:

docs/zh/task/model.md
docs/en/task/model.md

No Java tests were run because this is a docs-only comment change.

Checklist

Please check the following items before code is ready to be reviewed.

  • Related documentation has been updated.
  • Code is ready for review.

@JGoP-L JGoP-L requested review from a team and Copilot May 15, 2026 00:46
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Clarifies a misleading example comment in the DashScope thinking-mode docs so it reflects both behaviors (enabling thinking and the implicit streaming activation) implemented in DashScopeChatModel.

Changes:

  • Update Chinese docs comment from "自动启用流式输出" to "启用思考模式,并自动启用流式输出".
  • Apply the same clarification to the English docs.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
docs/zh/task/model.md Clarifies enableThinking(true) example comment in Chinese docs.
docs/en/task/model.md Mirrors the clarification in English docs.

@codecov
Copy link
Copy Markdown

codecov Bot commented May 15, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs]: Incorrect comment for enableThinking() in model.html code example

2 participants