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.

Sign up for GitHub

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

Jump to bottom

Fix JSDoc types #16888

Merged
merged 1 commit into from
Aug 31, 2023
Merged

Fix JSDoc types #16888

merged 1 commit into from
Aug 31, 2023

Conversation

stof
Copy link
Contributor

@stof stof commented Aug 31, 2023

This fixes invalid type references (either due to invalid paths for the import or missing imports) in the JS doc, as well as some missing or invalid parameter names for @param annotations.

Snuffleupagus
Snuffleupagus requested changes Aug 31, 2023
View reviewed changes
Copy link
Collaborator

@Snuffleupagus Snuffleupagus left a comment

Choose a reason for hiding this comment

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

Please note that the commit message should contain more information/context than only a single (very short) line. Basically, all the information in #16888 (comment) needs to be present in the commit message as well.

src/display/annotation_layer.js Outdated Show resolved Hide resolved
src/display/editor/editor.js Outdated Show resolved Hide resolved
web/ui_utils.js Outdated Show resolved Hide resolved
@stof stof force-pushed the fix_jsdoc_types branch 2 times, most recently from bf35261 to cabbff0 Compare August 31, 2023 10:36
@stof
Copy link
Contributor Author

stof commented Aug 31, 2023

@Snuffleupagus I updated the PR based on your feedback. I also fixed a few more issues detected when adding the web/pdf_viewer.component.js entrypoint in addition to src/pdf.js (not using both as done in the type generation was my mistake previously).

Snuffleupagus
Snuffleupagus requested changes Aug 31, 2023
View reviewed changes
src/display/annotation_layer.js Outdated Show resolved Hide resolved
src/display/transport_stream.js Outdated Show resolved Hide resolved
src/display/editor/editor.js Show resolved Hide resolved
@stof
Fix JSDoc types
f84f264 
This fixes invalid type references (either due to invalid paths for the
import or missing imports) in the JS doc, as well as some missing or
invalid parameter names for @param annotations.
@Snuffleupagus
Copy link
Collaborator

/botio-linux preview

@moz-tools-bot
Copy link
Collaborator

From: Bot.io (Linux m4)

Received

Command cmd_preview from @Snuffleupagus received. Current queue size: 0

Live output at: http://54.241.84.105:8877/a5831e013baf9ff/output.txt

@moz-tools-bot
Copy link
Collaborator

From: Bot.io (Linux m4)

Success

Full output at http://54.241.84.105:8877/a5831e013baf9ff/output.txt

Total script time: 1.57 mins

Published

@Snuffleupagus
Copy link
Collaborator

/botio integrationtest

@moz-tools-bot
Copy link
Collaborator

From: Bot.io (Linux m4)

Received

Command cmd_integrationtest from @Snuffleupagus received. Current queue size: 0

Live output at: http://54.241.84.105:8877/e3b348945f25100/output.txt

@moz-tools-bot
Copy link
Collaborator

From: Bot.io (Windows)

Received

Command cmd_integrationtest from @Snuffleupagus received. Current queue size: 0

Live output at: http://54.193.163.58:8877/6c02786753efea0/output.txt

@moz-tools-bot
Copy link
Collaborator

From: Bot.io (Linux m4)

Failed

Full output at http://54.241.84.105:8877/e3b348945f25100/output.txt

Total script time: 5.10 mins

  • Integration Tests: FAILED

@moz-tools-bot
Copy link
Collaborator

From: Bot.io (Windows)

Failed

Full output at http://54.193.163.58:8877/6c02786753efea0/output.txt

Total script time: 19.41 mins

  • Integration Tests: FAILED

Snuffleupagus
Snuffleupagus approved these changes Aug 31, 2023
View reviewed changes
Copy link
Collaborator

@Snuffleupagus Snuffleupagus left a comment

Choose a reason for hiding this comment

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

r=me, thank you!

@Snuffleupagus Snuffleupagus merged commit b159cc9 into mozilla:master Aug 31, 2023
3 checks passed
@stof stof deleted the fix_jsdoc_types branch August 31, 2023 15:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Snuffleupagus Snuffleupagus Snuffleupagus approved these changes

Assignees
No one assigned
Labels
other
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@stof @Snuffleupagus @moz-tools-bot