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

Reference documentation for Blockly.Events.* methods and constants is mostly useless #8586

Open
1 task done
cpcallen opened this issue Sep 23, 2024 · 0 comments
Open
1 task done
Labels
issue: bug Describes why the code or behaviour is wrong issue: docs Describes missing or incorrect documentation

Comments

@cpcallen
Copy link
Contributor

cpcallen commented Sep 23, 2024

Check for duplicates

  • I have searched for similar issues before opening a new one.

Description

The documentation for many of the constants and methods on Blockly.Events is more or less useless, describing all of these as variables (rather than constants / methods) and providing only uninformative type information). For example, Blockly.Events.setGroup is useless described as](https://developers.google.com/blockly/reference/js/blockly.events_namespace.setgroup_variable.md):

Events.setGroup variable

Signature:

setGroup: typeof eventUtils.setGroup

This is probably due to some interaction between how we reexport these methods and how API Extractor works and likely affects much of the rest of our documentation as well.

N.B.: How these methods are exported was changed in #8530 (to use export … from …), which might or might not be relevant.

@cpcallen cpcallen added issue: bug Describes why the code or behaviour is wrong issue: docs Describes missing or incorrect documentation issue: triage Issues awaiting triage by a Blockly team member and removed issue: triage Issues awaiting triage by a Blockly team member labels Sep 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
issue: bug Describes why the code or behaviour is wrong issue: docs Describes missing or incorrect documentation
Projects
None yet
Development

No branches or pull requests

1 participant