Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove or deprecate exported names ending in _ #5135

Closed
Tracked by #5026
cpcallen opened this issue Jul 20, 2021 · 0 comments
Closed
Tracked by #5026

Remove or deprecate exported names ending in _ #5135

cpcallen opened this issue Jul 20, 2021 · 0 comments
Labels
issue: feature request Describes a new feature and why it should be added

Comments

@cpcallen
Copy link
Contributor

Background

During the first pass converting goog.provide to goog.module, we are going export most or all existing exported identifiers, even ones marked @private and ending in underscore (_). This is being done to ensure that the initial conversion does not break other code within our own codebase (as well as in those of Blockly embedders).

Issue

Since:

  • it doesn't really make sense to export identifiers that are supposed to be private, and
  • we do not want external developers using these not-intended-to-be-public exports.

Suggested fix

We should either:

  • remove these exports (where doing does not and is not expected to break anything), or
  • mark them as @deprecated and wrapped with a call to the warn method from Blockly.utils.deprecation.

Alternatives considered

Doing nothing, and leaving them exported and not marked for deprecation. This runs the risk of them becoming de-facto parts of the API we need to continue to support in the future.

@cpcallen cpcallen added issue: feature request Describes a new feature and why it should be added issue: triage Issues awaiting triage by a Blockly team member labels Jul 20, 2021
@cpcallen cpcallen added this to the 2021_q3_release milestone Jul 20, 2021
@rachel-fenichel rachel-fenichel removed the issue: triage Issues awaiting triage by a Blockly team member label Jul 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
issue: feature request Describes a new feature and why it should be added
Projects
None yet
Development

No branches or pull requests

3 participants