-
Notifications
You must be signed in to change notification settings - Fork 29.8k
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
Document no-op console methods #16755
Comments
relevant #12675 |
Hi there! I'd like to pick this one up as my first contrib to core. Any more information you can give me on this one, just in case? |
From what I see, based on #12675 and on console.debug console.dirxml console.markTimeline
console.profile console.profileEnd console.table
console.timeStamp console.timeline console.timelineEnd Can someone confirm/infirm? |
These are NOT actually no-ops! All of the new-to-node There is no indication of these methods' existence in lib/console.js because they are not implemented in node. The methods were added by V8 starting with node v8.0 and are copied to node's Also, depending on how #15579 shakes out, this may be moot since that PR may end up removing these undocumented |
Thanks for the input @daguej ! If not, what about adding a new section 'Inspector only methods' explaining the deal and listing these methods? |
Okay, trying to wrap my head around a first draft just in case. As a first timer would-be committer, is there anything I should know? Are there some things automatically generated? Am I to write directly yhe markdown in the doc folder or is it somewhere else? In short, if someone as any kind of advice/how-to to provide me, that would be great. |
@Tiriel There are nothing in doc/ that is automatically generated; directly editing the markdown files is enough. |
@TimothyGu Awesome, thanks! |
Description inspired by dev tools reference and inspector err messages Added: * intro * console.debug() * console.dirxml() * console.markTimeline() * console.profile() * console.profileEnd() * console.table() * console.timeStamp() * console.timeline() * console.timelineEnd() Fixes: nodejs#16755
Following comments on original PR, added warning in each method's description Fixes: nodejs#16755 Refs: nodejs#17004 (comment)
Following review, changed one ref and added missing ones. Also corrected casing on non-primitive values. Fixes: nodejs#16755
Following review on PR Fixes: nodejs#16755
Following review, removed tab references. Fixes: nodejs#16755
As seen in PR nodejs#17033, console.debug() is being fully implemented. Removing its description from here to include it in the other PR Fixes: nodejs#16755 Refs: nodejs#17033 (comment)
Following review, replaced pseudo version number with REPLACEME Refs: nodejs#17004 (review) Fixes: nodejs#16755
Description inspired by dev tools reference and inspector err messages Added: * intro * console.debug() * console.dirxml() * console.markTimeline() * console.profile() * console.profileEnd() * console.table() * console.timeStamp() * console.timeline() * console.timelineEnd() PR-URL: #17004 Fixes: #16755 Reviewed-By: Khaidi Chu <i@2333.moe> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Description inspired by dev tools reference and inspector err messages Added: * intro * console.debug() * console.dirxml() * console.markTimeline() * console.profile() * console.profileEnd() * console.table() * console.timeStamp() * console.timeline() * console.timelineEnd() PR-URL: #17004 Fixes: #16755 Reviewed-By: Khaidi Chu <i@2333.moe> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Description inspired by dev tools reference and inspector err messages Added: * intro * console.debug() * console.dirxml() * console.markTimeline() * console.profile() * console.profileEnd() * console.table() * console.timeStamp() * console.timeline() * console.timelineEnd() PR-URL: #17004 Fixes: #16755 Reviewed-By: Khaidi Chu <i@2333.moe> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
I just noticed starting from Node@8,
console.debug()
is defined but it is a no-op.This causes my library to not behaving correctly.
It would be better to at least mention in the documentation that they are there but are no-op.
Are any of these has the same problem?
#1716 (comment)
The text was updated successfully, but these errors were encountered: