Improve the types generation and API documentation (PR 12102 follow-up) #12156
Conversation
timvandermeij
changed the title
|
/botio-linux preview |
From: Bot.io (Linux m4)ReceivedCommand cmd_preview from @timvandermeij received. Current queue size: 0 Live output at: http://54.67.70.0:8877/7b906377f212a83/output.txt |
From: Bot.io (Linux m4)SuccessFull output at http://54.67.70.0:8877/7b906377f212a83/output.txt Total script time: 3.46 mins Published |
There was a problem hiding this comment.
Looks much better already, however I couldn't help but spot a couple of (mostly pre-existing) issues.
Also, would it be possible to re-format this somehow, e.g. with line-breaks, to remove the eslint-disable/eslint-enable statements and improve overall readability (the ordering is also slightly weird, since Uint8ClampedArray should follow Uint8Array):
Lines 100 to 104 in 00a8b42
timvandermeij
force-pushed
the
types-followup
branch
2 times, most recently
from
d253e39 to
bd55f33
Compare
|
For easier review, the interdiffs at https://github.com/mozilla/pdf.js/compare/3f38d3fd2b8a284b3d7cce2b4b97f03c4f958e94..d253e3923222f14a3cc5062cd83b7b018e3b4d67 (ignore the last four files since they are from a merge of the existing |
|
/botio-linux preview |
From: Bot.io (Linux m4)ReceivedCommand cmd_preview from @timvandermeij received. Current queue size: 0 Live output at: http://54.67.70.0:8877/aefb8d821630503/output.txt |
From: Bot.io (Linux m4)SuccessFull output at http://54.67.70.0:8877/aefb8d821630503/output.txt Total script time: 3.49 mins Published |
This commit: - moves the preparation work to a new `typestest-pre` target similar to how the other targets work; - moves the `TYPESTEST_DIR` definition to the top of the file like we did for all other directory variables; - renames the `TYPES_BUILD_DIR` variable to `TYPES_DIR` since it's shorter and the naming scheme then corresponds to the other directory variables; - switches to `const`/template strings in the types targets where needed; - converts the `if (err !== null)` check to `if (err)` similar to other targets.
This commit: - formats the documentation block according to the standards; - replaces the callback definitions with the `function` type (we have that for other definitions already and the callback type was not rendered correctly by JSDoc); - synchronizes the type documentation and the class documentation; - fixes the documentation by making it easier to read and making sure that all optional properties are indicated as such; - uses the `@link` tag to indicate links to other code. The `typestest` still passes and JSDoc now renders this class correctly.
Over time we used multiple different formats for JSDoc comments. This commit standardizes those formats to the one we used most often. Moreover, this removes the example in the outline endpoint documentation since it now has a proper type definition and it didn't render correctly in JSDoc.
timvandermeij
force-pushed
the
types-followup
branch
from
bd55f33 to
56ca027
Compare
|
/botio-linux preview |
From: Bot.io (Linux m4)ReceivedCommand cmd_preview from @timvandermeij received. Current queue size: 0 Live output at: http://54.67.70.0:8877/7c75e8fb3b58b22/output.txt |
From: Bot.io (Linux m4)SuccessFull output at http://54.67.70.0:8877/7c75e8fb3b58b22/output.txt Total script time: 3.51 mins Published |
The commit messages contain more information about the individual changes. I recommend looking at the individual commits with the
?w=1flag since that reduces the diff size for some of them./cc @Snuffleupagus since this should fix the consistency problems and your last comments on the types patch.