fix: correct docs for flyout metrics #6751
Merged
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.
The basics
npm run format
andnpm run lint
The details
Resolves
incorrect documentation
Proposed Changes
getFlyoutMetrics
. This was incorrect before unless you passtrue
as the parameter.@see
tag ingetToolboxMetrics
.@see
is a block tag, which means it expects to be on its own line. Other usages of the@see
tag in the codebase appear to be fine after quick inspectionprocedures.js
was just from runningnpm run format
Behavior Before Change
incorrect docs and broken for this function: https://developers.google.com/blockly/reference/js/blockly.metricsmanager_class.gettoolboxmetrics_1_method.md
Behavior After Change
Reason for Changes
Test Coverage
Documentation
Additional Information