Skip to content

fix: mark removeAllMakers as @deprecated in Scene class - #2816

Merged
hustcc merged 2 commits into
masterfrom
copilot/fix-remove-all-markers-typo
Feb 25, 2026
Merged

fix: mark removeAllMakers as @deprecated in Scene class#2816
hustcc merged 2 commits into
masterfrom
copilot/fix-remove-all-markers-typo

Conversation

Copilot AI commented Feb 25, 2026

Copy link
Copy Markdown
Contributor

The Scene class exposed a public method removeAllMakers (typo — missing r) alongside the correct removeAllMarkers, causing the generated .d.ts to surface the misspelled name without any deprecation signal, contradicting the documentation.

Changes

  • packages/scene/src/index.ts: Added @deprecated JSDoc annotation to removeAllMakers, pointing users to removeAllMarkers
/**
 * @deprecated 请使用 removeAllMarkers
 */
public removeAllMakers() {
  console.warn('removeAllMakers 已废弃,请使用 removeAllMarkers');
  this.markerService.removeAllMarkers();
}

The typo method is preserved for backward compatibility but will now surface as deprecated in IDE tooling and the generated .d.ts.

Original prompt

This section details on the original issue you should resolve

<issue_title>.d.ts与文档内容不一致</issue_title>
<issue_description>### 问题描述

文档上是removeAllMarkers
.d.ts标注是removeAllMakers

重现链接

No response

重现步骤

No response

预期行为

No response

平台

  • 操作系统: [macOS, Windows, Linux, React Native ...]
  • 网页浏览器: [Google Chrome, Safari, Firefox]

屏幕截图或视频(可选)

No response

补充说明(可选)

No response</issue_description>

<agent_instructions>修复一下。</agent_instructions>

Comments on the Issue (you are @copilot in this section)

@lzxue 感谢可以反馈,应该是编写错误

🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

@changeset-bot

changeset-bot Bot commented Feb 25, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: fd5e11a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Co-authored-by: hustcc <7856674+hustcc@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix typo in .d.ts file related to removeAllMarkers fix: mark removeAllMakers as @deprecated in Scene class Feb 25, 2026
Copilot AI requested a review from hustcc February 25, 2026 04:10
@hustcc
hustcc marked this pull request as ready for review February 25, 2026 04:14
@hustcc
hustcc merged commit 7773425 into master Feb 25, 2026
10 checks passed
@hustcc
hustcc deleted the copilot/fix-remove-all-markers-typo branch February 25, 2026 04:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

.d.ts与文档内容不一致

2 participants