docs: update valueType links in table.md documentation#9609
docs: update valueType links in table.md documentation#9609GeoDaoyu wants to merge 2 commits intoant-design:masterfrom
Conversation
📝 WalkthroughWalkthrough修复了 Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@site/components/table.md`:
- Line 65: The heading "### 常见 ValueType" in schema-form.md must be changed to
include an explicit English anchor — replace that heading with "### 常见 ValueType
{`#common-valuetypes`}" (refer to the header text "### 常见 ValueType") and update
all links in table.md that point to the old auto-generated Chinese anchor
(currently `#常见-valuetype`) to the new `#common-valuetypes` (update the
occurrences on the lines referencing the table links, e.g., the links in
table.md that currently use `#常见-valuetype`); finally, scan other markdown
headers for Chinese-starting anchors and add manual English anchors following
the same pattern to satisfy the anchor regex.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 67eb78cc-2102-4067-a961-a268c8771dfd
📒 Files selected for processing (2)
site/components/table.en-US.mdsite/components/table.md
| ``` | ||
|
|
||
| 列配置中也支持 `request`,但是只有几种 [valueType](/components/schema#valuetype) 支持。 | ||
| 列配置中也支持 `request`,但是只有几种 [valueType](/components/schema-form#常见-valuetype) 支持。 |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# 验证 schema-form.md 中 ValueType 相关章节的锚点定义
echo "=== 检查 schema-form.md 中的 ValueType 章节 ==="
rg -n -A2 "^###\s+常见\s+ValueType" site/components/schema-form.md
echo -e "\n=== 检查 schema-form.en-US.md 中的对应章节 ==="
rg -n -A2 "^###\s+Common\s+ValueType" site/components/schema-form.en-US.md
echo -e "\n=== 搜索可能的手动英文锚点定义 ==="
rg -n "\{#[a-zA-Z][\w-:\.]*\}" site/components/schema-form.md site/components/schema-form.en-US.mdRepository: ant-design/pro-components
Length of output: 432
修复 schema-form.md 中的锚点规范违规,并更新对应链接。
验证发现 schema-form.md 中的标题"### 常见 ValueType"(第 81 行)未定义手动英文锚点,自动生成的锚点将以中文字符开头(#常见-valuetype),违反编码规范要求 ^[a-zA-Z][\w-:\.]*$(锚点必须以字母开头)。
需要将该标题修改为:### 常见 ValueType {#common-valuetypes},并更新 site/components/table.md 中对应位置(第 65、259、286、308 行)的所有链接,从 #常见-valuetype 改为 #common-valuetypes。同时检查是否还有其他中文标题存在相同问题。
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@site/components/table.md` at line 65, The heading "### 常见 ValueType" in
schema-form.md must be changed to include an explicit English anchor — replace
that heading with "### 常见 ValueType {`#common-valuetypes`}" (refer to the header
text "### 常见 ValueType") and update all links in table.md that point to the old
auto-generated Chinese anchor (currently `#常见-valuetype`) to the new
`#common-valuetypes` (update the occurrences on the lines referencing the table
links, e.g., the links in table.md that currently use `#常见-valuetype`); finally,
scan other markdown headers for Chinese-starting anchors and add manual English
anchors following the same pattern to satisfy the anchor regex.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #9609 +/- ##
==========================================
- Coverage 88.53% 88.48% -0.05%
==========================================
Files 368 368
Lines 11257 11257
Branches 4157 4154 -3
==========================================
- Hits 9966 9961 -5
- Misses 1139 1143 +4
- Partials 152 153 +1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Code Review
This pull request updates documentation links for valueType in both the English and Chinese versions of the table component documentation. The feedback focuses on improving formatting consistency by wrapping valueType in backticks and enhancing the clarity of link text in the Chinese documentation to match the English style.
| ``` | ||
|
|
||
| `request` is also supported in column configuration, but only for a few [valueType](/components/schema#valuetype). | ||
| `request` is also supported in column configuration, but only for a few [valueType](/components/schema-form#common-valuetypes). |
There was a problem hiding this comment.
For consistency with other links in this document and to correctly format the property name, valueType should be wrapped in backticks.
| `request` is also supported in column configuration, but only for a few [valueType](/components/schema-form#common-valuetypes). | |
| `request` is also supported in column configuration, but only for a few [`valueType`](/components/schema-form#common-valuetypes). |
| ``` | ||
|
|
||
| 列配置中也支持 `request`,但是只有几种 [valueType](/components/schema#valuetype) 支持。 | ||
| 列配置中也支持 `request`,但是只有几种 [valueType](/components/schema-form#常见-valuetype) 支持。 |
There was a problem hiding this comment.
For consistency with other links in this document and to correctly format the property name, valueType should be wrapped in backticks.
| 列配置中也支持 `request`,但是只有几种 [valueType](/components/schema-form#常见-valuetype) 支持。 | |
| 列配置中也支持 `request`,但是只有几种 [`valueType`](/components/schema-form#常见-valuetype) 支持。 |
| 按照规范,table 的表单不需要任何的必选参数,所有点击搜索和重置都会触发 `request` 来发起一次查询。 | ||
|
|
||
| Form 的列是根据 `valueType` 来生成不同的类型,详细的值类型请查看[通用配置](/components/schema#valuetype)。 | ||
| Form 的列是根据 `valueType` 来生成不同的类型,详细的值类型请查看[通用配置](/components/schema-form#常见-valuetype)。 |
There was a problem hiding this comment.
The link text '通用配置' (General Configuration) is a bit vague. It would be clearer to link the valueType term directly, matching the English documentation's style and making the sentence more concise.
| Form 的列是根据 `valueType` 来生成不同的类型,详细的值类型请查看[通用配置](/components/schema-form#常见-valuetype)。 | |
| Form 的列是根据 [`valueType`](/components/schema-form#常见-valuetype) 来生成不同的类型。 |
fix #9586
Summary by CodeRabbit
发布说明
valueType的多个文档链接指向,将用户指引至新的文档位置,确保文档引用的一致性和准确性。