Skip to content

doc: util.debuglog callback - #33856

Closed
bmeck wants to merge 7 commits into
nodejs:masterfrom
bmeck:debuglog-callback-doc
Closed

doc: util.debuglog callback#33856
bmeck wants to merge 7 commits into
nodejs:masterfrom
bmeck:debuglog-callback-doc

Conversation

@bmeck

Copy link
Copy Markdown
Member
Checklist

@bmeck
bmeck requested a review from mscdexJune 12, 2020 14:24
@nodejs-github-botnodejs-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
Copy Markdown
MemberAuthor

API came from #32260

@mscdex

Copy link
Copy Markdown
Contributor

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
Copy Markdown
MemberAuthor

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

Comment threaddoc/api/util.md Outdated
Comment threaddoc/api/util.md Outdated
@Trott

Copy link
Copy Markdown
Member

@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.)

Comment threaddoc/api/util.md Outdated
Comment threaddoc/api/util.md Outdated
Comment threaddoc/api/util.md Outdated
Comment threaddoc/api/util.md Outdated
@bmeck

Copy link
Copy Markdown
MemberAuthor

@targos those should be fixed now, thanks

Comment threaddoc/api/util.md
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
Copy Markdown
Member

Landed in 16f3b6a

@jasnelljasnell closed this Jul 3, 2020

@mhdawsonmhdawson 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.

LGTM

MylesBorins pushed a commit that referenced this pull request Jul 14, 2020
PR-URL: #33856
Reviewed-By: James M Snell <jasnell@gmail.com>
@MylesBorinsMylesBorins 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>
@codebyterecodebytere mentioned this pull request Sep 28, 2020
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docIssues and PRs related to the documentations.utilIssues and PRs related to the built-in util module.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants

@bmeck@mscdex@Trott@jasnell@mhdawson@rexagod@nodejs-github-bot