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

chore: fixed tsdoc missing deprecation messages #6460

Merged

Conversation

btw17
Copy link
Member

@btw17 btw17 commented Sep 30, 2022

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

This resolves missing deprecation messages.

Proposed Changes

  • Added @deprecated messages and updated ./api-extractor.json to no longer ignore logs for "tsdoc-missing-deprecation-message"
  • Updated the blockly alias to be bolded for some deprecation messages in ./core/utils.ts.
  • Removed @internal from runAfterPageLoad in ./core/extensions.ts

Behavior Before Change

  • Some @deprecated notices did not have messages to display.

Behavior After Change

  • All @deprecated notices have messages to display.
  • Deprecation messages display in bold.

Reason for Changes

This is a cleanup task to provide more information to function descriptions and, by extension, the documentation.

Test Coverage

N/A for automated tests, though I manually tested this change by running npx @microsoft/api-extractor run --local from the root. I used that command to identify the missing messages and confirmed it was good to go after the updates.

Documentation

General documentation needs to be updated, though no new documentation needs to be created.

Additional Information

There are a few minor tweaks which I made assumptions for, though I'm not entirely sure if they're correct:

@btw17 btw17 requested a review from a team as a code owner September 30, 2022 20:47
@btw17 btw17 requested a review from NeilFraser September 30, 2022 20:47
@BeksOmega BeksOmega removed the request for review from NeilFraser September 30, 2022 21:07
@BeksOmega BeksOmega assigned BeksOmega and unassigned NeilFraser Sep 30, 2022
@BeksOmega BeksOmega self-requested a review September 30, 2022 21:07
Copy link
Collaborator

@BeksOmega BeksOmega left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally looks great! Thank you for the fixes :D

Wrt your questions, generally your judgement/investigation is good! But we want to revert the changes to runAfterPageLoad.

core/utils.ts Outdated Show resolved Hide resolved
@@ -350,7 +350,7 @@ function mutatorPropertiesMatch(
*
* @param fn Function to run.
* @throws Error Will throw if no global document can be found (e.g., Node.js).
* @internal
* @alias Blockly.extensions.runAfterPageLoad
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please revert this as well.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed!

core/utils.ts Show resolved Hide resolved
core/utils.ts Outdated Show resolved Hide resolved
@btw17
Copy link
Member Author

btw17 commented Sep 30, 2022

All set!

@BeksOmega BeksOmega merged commit e0b60cb into google:develop Sep 30, 2022
@btw17 btw17 deleted the chore/tsdoc-missing-deprecation-messages branch September 30, 2022 21:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants