Skip to content

fix: correct docs for flyout metrics#6751

Merged
maribethb merged 1 commit into
RaspberryPiFoundation:developfrom
maribethb:flyout-doc
Jan 10, 2023
Merged

fix: correct docs for flyout metrics#6751
maribethb merged 1 commit into
RaspberryPiFoundation:developfrom
maribethb:flyout-doc

Conversation

@maribethb

@maribethb maribethb commented Jan 10, 2023

Copy link
Copy Markdown
Contributor

The basics

  • I branched from develop
  • My pull request is against develop
  • My code follows the style guide
  • I ran npm run format and npm run lint

The details

Resolves

incorrect documentation

Proposed Changes

  • Corrects the information for getFlyoutMetrics. This was incorrect before unless you pass true as the parameter.
  • Fixes syntax for the @see tag in getToolboxMetrics. @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 inspection
  • The change in procedures.js was just from running npm 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

@maribethb maribethb requested a review from a team as a code owner January 10, 2023 21:48
@github-actions github-actions Bot added the PR: fix Fixes a bug label Jan 10, 2023
@BeksOmega BeksOmega requested review from BeksOmega and removed request for rachel-fenichel January 10, 2023 21:49
@maribethb maribethb merged commit 25d9acb into RaspberryPiFoundation:develop Jan 10, 2023
@github-actions github-actions Bot added PR: fix Fixes a bug and removed PR: fix Fixes a bug labels Jan 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

PR: fix Fixes a bug

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants