FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: correct tracingChannel.traceCallback() by Flarna · Pull Request #51068 · nodejs/node · GitHub

/ node Public

doc: correct tracingChannel.traceCallback() - #51068

Merged
nodejs-github-bot merged 2 commits into
nodejs:mainfrom
Flarna:gst/diag-channel-trace-callback
Dec 8, 2023
Merged

doc: correct tracingChannel.traceCallback()#51068
nodejs-github-bot merged 2 commits into
nodejs:mainfrom
Flarna:gst/diag-channel-trace-callback

Conversation

Flarna commented Dec 6, 2023
edited
Loading

Copy link
Copy Markdown
Member

tracingChannel.traceCallback() requires a callback otherwise it throws and invalid argument error. As a result arguments are not optional.

Correct the documentation to reflect that arguments are not optional.

Besides that correct description regarding signaling of errors.

Remove an unneeded null check in wrappedCallback() which can't happen because it's validated that callback is of type function.

Fixes: #50996

nodejs-github-bot added diagnostics_channel Issues and PRs related to diagnostics channel needs-ci PRs that need a full CI run. labels Dec 6, 2023
Flarna force-pushed the gst/diag-channel-trace-callback branch from 481f145 to e1e19b5 Compare December 6, 2023 07:48
Flarna requested a review from Qard December 6, 2023 07:53
tracingChannel.traceCallback() requires a callback otherwise it throws
and invalid argument error. As a result arguments are not optional.

Correct the documentation to reflect that arguments are not optional.

Besides that correct description regarding signaling of errors.

Remove an unneeded null check in wrappedCallback() which can't happen
because it's validated that callback is of type function.
Flarna force-pushed the gst/diag-channel-trace-callback branch from e1e19b5 to 1559cd8 Compare December 6, 2023 07:58

Qard left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Other than typo, LGTM.

Comment thread doc/api/diagnostics_channel.md Outdated
Co-authored-by: Stephen Belanger <admin@stephenbelanger.com>
Flarna added the request-ci Add this label to start a Jenkins CI on a PR. label Dec 6, 2023
github-actions Bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Dec 6, 2023

Copy link
Copy Markdown
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/56128/

Flarna added the author ready PRs that have at least one approval, no outstanding review comments, and a CI started. label Dec 7, 2023
Flarna added commit-queue Add this label to land a pull request using GitHub Actions. commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. labels Dec 8, 2023
nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Dec 8, 2023
nodejs-github-bot merged commit 3f942e2 into nodejs:main Dec 8, 2023

Copy link
Copy Markdown
Collaborator

Landed in 3f942e2

Flarna deleted the gst/diag-channel-trace-callback branch December 8, 2023 22:26
RafaelGSS pushed a commit that referenced this pull request Dec 15, 2023
tracingChannel.traceCallback() requires a callback otherwise it throws
and invalid argument error. As a result arguments are not optional.

Correct the documentation to reflect that arguments are not optional.

Besides that correct description regarding signaling of errors.

Remove an unneeded null check in wrappedCallback() which can't happen
because it's validated that callback is of type function.

PR-URL: #51068
Fixes: #50996
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
RafaelGSS mentioned this pull request Dec 15, 2023
richardlau pushed a commit that referenced this pull request Mar 25, 2024
tracingChannel.traceCallback() requires a callback otherwise it throws
and invalid argument error. As a result arguments are not optional.

Correct the documentation to reflect that arguments are not optional.

Besides that correct description regarding signaling of errors.

Remove an unneeded null check in wrappedCallback() which can't happen
because it's validated that callback is of type function.

PR-URL: #51068
Fixes: #50996
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
richardlau mentioned this pull request Mar 25, 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author ready PRs that have at least one approval, no outstanding review comments, and a CI started. commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. diagnostics_channel Issues and PRs related to diagnostics channel needs-ci PRs that need a full CI run.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[diagnostics_channel] tracingChannel.traceCallback incorrect types

5 participants


Back | FazBrowse Home | New Git URL