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.

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

doc: util.debuglog callback #33856

Closed
wants to merge 7 commits into from
Closed

Conversation

bmeck
Copy link
Member

@bmeck bmeck commented Jun 12, 2020

Checklist

@bmeck bmeck requested a review from mscdex June 12, 2020 14:24
@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. util Issues and PRs related to the built-in util module. labels Jun 12, 2020
@bmeck
Copy link
Member Author

bmeck commented Jun 12, 2020

API came from #32260

@mscdex
Copy link
Contributor

mscdex commented Jun 12, 2020

I don't think it's really worth documenting this as it's purely an (internal) optimization. The callback isn't for determining whether debugging is enabled, in fact the argument passed to the callback is always a function. The callback is used to get a reference to a more optimized (by V8) debug function.

@bmeck
Copy link
Member Author

bmeck commented Jun 12, 2020

@mscdex it is exposed publicly so it seems like it should be documented. will fixup the docs though

doc/api/util.md Outdated Show resolved Hide resolved
doc/api/util.md Outdated Show resolved Hide resolved
@Trott
Copy link
Member

Trott commented Jun 13, 2020

@bmeck There are still a two or three things flagged in the GitHub interface that look like they are worth addressing. (Can't assign the new value to debuglog because it's a const, for example.)

doc/api/util.md Outdated Show resolved Hide resolved
doc/api/util.md Outdated Show resolved Hide resolved
doc/api/util.md Outdated Show resolved Hide resolved
doc/api/util.md Outdated Show resolved Hide resolved
@bmeck
Copy link
Member Author

bmeck commented Jun 15, 2020

@targos those should be fixed now, thanks

jasnell pushed a commit that referenced this pull request Jul 3, 2020
PR-URL: #33856
Reviewed-By: James M Snell <jasnell@gmail.com>
@jasnell
Copy link
Member

jasnell commented Jul 3, 2020

Landed in 16f3b6a

@jasnell jasnell closed this Jul 3, 2020
Copy link
Member

@mhdawson mhdawson left a comment

Choose a reason for hiding this comment

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

LGTM

MylesBorins pushed a commit that referenced this pull request Jul 14, 2020
PR-URL: #33856
Reviewed-By: James M Snell <jasnell@gmail.com>
@MylesBorins MylesBorins mentioned this pull request Jul 14, 2020
MylesBorins pushed a commit that referenced this pull request Jul 16, 2020
PR-URL: #33856
Reviewed-By: James M Snell <jasnell@gmail.com>
addaleax pushed a commit that referenced this pull request Sep 22, 2020
PR-URL: #33856
Reviewed-By: James M Snell <jasnell@gmail.com>
@codebytere codebytere mentioned this pull request Sep 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. util Issues and PRs related to the built-in util module.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants