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

doc: doc-only deprecation for util.log() #6161

Closed
wants to merge 1 commit into from
Closed

doc: doc-only deprecation for util.log() #6161

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion doc/api/util.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ where `3245` is the process id. If it is not run with that
environment variable set, then it will not print anything.

You may separate multiple `NODE_DEBUG` environment variables with a
comma. For example, `NODE_DEBUG=fs,net,tls`.
comma. For example, `NODE_DEBUG=fs,net,tls`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Unrelated change and it is possibly accepted by many.


## util.deprecate(function, string)

Expand Down Expand Up @@ -551,6 +551,8 @@ util.isUndefined(null)

## util.log(string)

Stability: 0 - Deprecated: Use a third party userland module instead.
Copy link
Contributor

Choose a reason for hiding this comment

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

userland is maybe redundant here? Maybe also just point to .debuglog()? Even though there are no timestamps.

Copy link
Contributor

Choose a reason for hiding this comment

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

debuglog() is quite different. See below:

Output with timestamp on stdout.


Output with timestamp on `stdout`.

require('util').log('Timestamped message.');
Expand Down