-
Notifications
You must be signed in to change notification settings - Fork 3.7k
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
chore: fixed tsdoc missing deprecation messages #6460
Conversation
There was a problem hiding this 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/extensions.ts
Outdated
@@ -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 |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed!
All set! |
The basics
npm run format
andnpm run lint
The details
Resolves
This resolves missing deprecation messages.
Proposed Changes
@deprecated
messages and updated./api-extractor.json
to no longer ignore logs for"tsdoc-missing-deprecation-message"
./core/utils.ts
.@internal
from runAfterPageLoad in./core/extensions.ts
Behavior Before Change
@deprecated
notices did not have messages to display.Behavior After Change
@deprecated
notices have messages to display.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
@deprecated
was added to the core utils functions below:There are a few minor tweaks which I made assumptions for, though I'm not entirely sure if they're correct:
./core/utils.ts
, the message fornoEvent
and comments around its replacement suggest it's no longer needed../core/utils.ts
, updated the deprecation warning forarrayRemove
to include the alternate function to use../core/utils.ts
, same as with (2) forrunAfterPageLoad
. The catch is the function that replaces it was marked internal../core/extensions.ts
to markrunAfterPageLoad
with an alias instead of internal.