Skip to content

[Feature] 重构参数描述逻辑并精简文档 / Refactor parameter description logic and streamline documentation #127

@SunYanbox

Description

@SunYanbox

状态 / Status: 提议,尚未开始 / Proposed, not started

描述 / Description
当前参数描述存在冗余和歧义问题:文档中 param 标签内包含 type 参数,这会导致模型解析时产生混淆。需要重构参数描述逻辑,精简过于繁琐的 doc 文档,并移除所有示例工具中 param 标签里的 type 参数。
The current parameter description has redundancy and ambiguity issues: the type parameter inside param tags in the documentation causes confusion for model parsing. We need to refactor the parameter description logic, streamline the overly verbose doc documentation, and remove the type parameter from all param tags in example tools.

改动范围 / Scope of changes

  • 精简 doc 文档,去除冗长描述 / Streamline doc documents by removing lengthy descriptions
  • 从示例工具的 param 标签中移除 type 参数 / Remove the type parameter from param tags in example tools
  • 调整参数描述逻辑,保持清晰且无歧义 / Adjust parameter description logic to keep it clear and unambiguous

预期收益 / Expected benefits

  • 提升文档可读性与维护性 / Improved documentation readability and maintainability
  • 降低模型对参数类型解析的错误率 / Reduced error rate in model parameter type parsing
  • 减少跨工具接口的不一致风险 / Reduced risk of inconsistency across tool interfaces

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions