docs(source): 补全兼容性说明与弃用提示，修正 en 文档 embed 引用 - #2883
Merged
Merged
Conversation
source.{zh,en}.md 新增「兼容性 / Compatibility」小节：明确旧 new Source(data, cfg) /
cluster: true / ISourceCFG 旧字段 / 'update' 事件全部向后兼容，新 API 为可选迁移路径。
cluster 段补弃用提示：transforms: [{ type: 'cluster' }] 已弃用，改用 cluster: true。
修正 en 文档既有 embed 引用 bug：source.en.md / mvt.en.md / raster_tile.en.md 原嵌入
method.zh.md（中文）→ 改为 method.en.md（英文版早已存在）。该 bug 非 本次重构引入
（commit 1d5c5fa），本轮顺手修正。
重构存档同步：README「当前状态」更新为阶段 0-6 已合并；PROGRESS 追加 PR #2882 合并 /
文档补全 / 兼容性核查三条记录。
Contributor
|
Caution The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased. |
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
背景
接 PR #2882（
@antv/l7-source渐进式重构阶段 0-6 已合并）后的文档收尾。用户确认「兼容原来写法」后，盘点发现若干文档需要同步更新。改动
A. API 文档补兼容性 / 弃用说明
source.{zh,en}.md新增「兼容性 / Compatibility」小节：明确旧new Source(data, cfg)/cluster: true/ISourceCFG旧字段 /'update'事件全部向后兼容，新 API（Source.create/createSource/ready/stats()/dataVersion）为可选迁移路径。cluster段补弃用提示：transforms: [{ type: 'cluster' }]已弃用（阶段 4.4，运行时 warn 一次但仍工作），改用顶层cluster: true。B. 修正 en 文档既有 embed 引用 bug
source.en.md/mvt.en.md/raster_tile.en.md原嵌入method.zh.md（中文）→ 改为method.en.md（英文版早已存在）。1d5c5fa，非本次重构引入），本轮顺手修正，使英文文档不再混入中文瓦片方法说明。C. 重构存档同步
docs/refactoring/source/README.md「当前状态」：从「阶段 0」更新为「阶段 0-6 已合并（PR refactor(source): @antv/l7-source 渐进式重构（阶段 0-6，happy path 零行为变化） #2882, mergecd654c1）」。docs/refactoring/source/PROGRESS.md：追加 PR refactor(source): @antv/l7-source 渐进式重构（阶段 0-6，happy path 零行为变化） #2882 合并 / 文档补全（1831635）/ 兼容性核查三条倒序记录，保持可回溯。验证
method.zh.md残留已清零（grep 确认无残留）。影响范围
仅文档，无 changeset 需要，无行为变化。
关联