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

doc: make some parameters optional in tracingChannel.traceCallback #54068

Closed
wants to merge 1 commit into from
Closed

doc: make some parameters optional in tracingChannel.traceCallback #54068

wants to merge 1 commit into from

Conversation

deokjinkim
Copy link
Contributor

@deokjinkim deokjinkim commented Jul 27, 2024 •
edited
Loading

Plus, add missing position parameter to CJS example.

node/lib/diagnostics_channel.js

Line 377 in 3779c2c

traceCallback(fn, position = -1, context = {}, thisArg, ...args) {

ESM example of tracingChannel.traceCallback (line: 917)

node/doc/api/diagnostics_channel.md

Lines 910 to 919 in 3779c2c

import diagnostics_channel from 'node:diagnostics_channel';
const channels = diagnostics_channel.tracingChannel('my-channel');
channels.traceCallback((arg1, callback) => {
// Do something
callback(null, 'result');
}, 1, {
some: 'thing',
}, thisArg, arg1, callback);

@deokjinkim
doc: make some parameters optional in tracingChannel.traceCallback
149b8b6 
Plus, add missing `position` parameter to CJS example.
@nodejs-github-bot nodejs-github-bot added diagnostics_channel Issues and PRs related to diagnostics channel doc Issues and PRs related to the documentations. labels Jul 27, 2024
@deokjinkim deokjinkim marked this pull request as ready for review July 27, 2024 13:44
@deokjinkim deokjinkim added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. commit-queue Add this label to land a pull request using GitHub Actions. labels Jul 28, 2024
@nodejs-github-bot nodejs-github-bot added commit-queue-failed An error occurred while landing this pull request using GitHub Actions. and removed commit-queue Add this label to land a pull request using GitHub Actions. labels Jul 29, 2024
@nodejs-github-bot
Copy link
Collaborator

Commit Queue failed
- Loading data for nodejs/node/pull/54068
✔  Done loading data for nodejs/node/pull/54068
----------------------------------- PR info ------------------------------------
Title      doc: make some parameters optional in `tracingChannel.traceCallback` (#54068)
Author     Deokjin Kim <[email protected]> (@deokjinkim)
Branch     deokjinkim:240727_make_parameter_optional_in_dc -> nodejs:main
Labels     doc, author ready, diagnostics_channel
Commits    1
 - doc: make some parameters optional in `tracingChannel.traceCallback`
Committers 1
 - Deokjin Kim <[email protected]>
PR-URL: https://github.com/nodejs/node/pull/54068
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Benjamin Gruenbaum <[email protected]>
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/54068
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Benjamin Gruenbaum <[email protected]>
--------------------------------------------------------------------------------
   ℹ  This PR was created on Sat, 27 Jul 2024 13:43:58 GMT
   ✔  Approvals: 2
   ✔  - Luigi Pinca (@lpinca): https://github.com/nodejs/node/pull/54068#pullrequestreview-2203203591
   ✔  - Benjamin Gruenbaum (@benjamingr) (TSC): https://github.com/nodejs/node/pull/54068#pullrequestreview-2203227557
   ✘  Last GitHub CI failed
   ℹ  Green GitHub CI is sufficient
--------------------------------------------------------------------------------
   ✔  Aborted `git node land` session in /home/runner/work/node/node/.ncu
https://github.com/nodejs/node/actions/runs/10145586107

@deokjinkim deokjinkim marked this pull request as draft July 31, 2024 15:27
@deokjinkim deokjinkim marked this pull request as ready for review July 31, 2024 15:28
@UlisesGascon UlisesGascon added commit-queue Add this label to land a pull request using GitHub Actions. and removed commit-queue-failed An error occurred while landing this pull request using GitHub Actions. labels Jul 31, 2024
@nodejs-github-bot nodejs-github-bot added commit-queue-failed An error occurred while landing this pull request using GitHub Actions. and removed commit-queue Add this label to land a pull request using GitHub Actions. labels Jul 31, 2024
@nodejs-github-bot
Copy link
Collaborator

Commit Queue failed
- Loading data for nodejs/node/pull/54068
✔  Done loading data for nodejs/node/pull/54068
----------------------------------- PR info ------------------------------------
Title      doc: make some parameters optional in `tracingChannel.traceCallback` (#54068)
Author     Deokjin Kim <[email protected]> (@deokjinkim)
Branch     deokjinkim:240727_make_parameter_optional_in_dc -> nodejs:main
Labels     doc, author ready, diagnostics_channel
Commits    1
 - doc: make some parameters optional in `tracingChannel.traceCallback`
Committers 1
 - Deokjin Kim <[email protected]>
PR-URL: https://github.com/nodejs/node/pull/54068
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Benjamin Gruenbaum <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Ulises Gascón <[email protected]>
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/54068
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Benjamin Gruenbaum <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Ulises Gascón <[email protected]>
--------------------------------------------------------------------------------
   ℹ  This PR was created on Sat, 27 Jul 2024 13:43:58 GMT
   ✔  Approvals: 4
   ✔  - Luigi Pinca (@lpinca): https://github.com/nodejs/node/pull/54068#pullrequestreview-2203203591
   ✔  - Benjamin Gruenbaum (@benjamingr) (TSC): https://github.com/nodejs/node/pull/54068#pullrequestreview-2203227557
   ✔  - James M Snell (@jasnell) (TSC): https://github.com/nodejs/node/pull/54068#pullrequestreview-2205601700
   ✔  - Ulises Gascón (@UlisesGascon): https://github.com/nodejs/node/pull/54068#pullrequestreview-2210901127
   ✘  Last GitHub CI failed
   ℹ  Green GitHub CI is sufficient
--------------------------------------------------------------------------------
   ✔  Aborted `git node land` session in /home/runner/work/node/node/.ncu
https://github.com/nodejs/node/actions/runs/10186057259

jakecastelli pushed a commit that referenced this pull request Aug 7, 2024
@deokjinkim @jakecastelli
doc: make some parameters optional in tracingChannel.traceCallback
a4f609f 
Plus, add missing `position` parameter to CJS example.

PR-URL: #54068
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Benjamin Gruenbaum <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Ulises Gascón <[email protected]>
Reviewed-By: Jake Yuesong Li <[email protected]>
@jakecastelli
Copy link
Contributor

Landed in a4f609f

targos pushed a commit that referenced this pull request Aug 14, 2024
@deokjinkim @targos
doc: make some parameters optional in tracingChannel.traceCallback
55f8ac3 
Plus, add missing `position` parameter to CJS example.

PR-URL: #54068
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Benjamin Gruenbaum <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Ulises Gascón <[email protected]>
Reviewed-By: Jake Yuesong Li <[email protected]>
@RafaelGSS RafaelGSS mentioned this pull request Aug 19, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jasnell jasnell jasnell approved these changes

@benjamingr benjamingr benjamingr approved these changes

@lpinca lpinca lpinca approved these changes

@UlisesGascon UlisesGascon UlisesGascon approved these changes

@jakecastelli jakecastelli jakecastelli approved these changes

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. commit-queue-failed An error occurred while landing this pull request using GitHub Actions. diagnostics_channel Issues and PRs related to diagnostics channel doc Issues and PRs related to the documentations.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@deokjinkim @nodejs-github-bot @jakecastelli @jasnell @benjamingr @lpinca @UlisesGascon