doc: doc-only deprecation for util.log() #6161
Conversation
| @@ -551,6 +551,8 @@ util.isUndefined(null) | |||
|
|
|||
| ## util.log(string) | |||
|
|
|||
| Stability: 0 - Deprecated | |||
There was a problem hiding this comment.
Perhaps include some alternative recommendation?
There was a problem hiding this comment.
Could we recommend 3rd package?
There was a problem hiding this comment.
Recommending a specific third party package would be problematic, but saying something like, "Use a third party userland module instead" would be ok.
There are more powerful loggers in user land like `debug`, soft deprecate it.
|
@jasnell I updated it. |
| @@ -551,6 +551,8 @@ util.isUndefined(null) | |||
|
|
|||
| ## util.log(string) | |||
|
|
|||
| Stability: 0 - Deprecated: Use a third party userland module instead. | |||
There was a problem hiding this comment.
userland is maybe redundant here? Maybe also just point to .debuglog()? Even though there are no timestamps.
There was a problem hiding this comment.
debuglog() is quite different. See below:
Output with timestamp on
stdout.
|
Deprecating a method on a stable module should be semver major and ctc agenda. +1 for deprecating it though. |
benjamingr
added
doc
|
This LGTM but adding it to the CTC agenda for a quick review |
|
@nodejs/ctc |
|
LGTM |
| @@ -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`. | |||
There was a problem hiding this comment.
Unrelated change and it is possibly accepted by many.
|
LGTM with @thefourtheye nit addressed |
|
@nodejs/ctc discussed this and decided to move forward with it. If there are no further objections by monday I will land before v6 is cut. There may need to be some additional tweaks to the actual text in the docs. |
|
LGTM. Fixing a couple of nits on landing |
There are more powerful loggers in user land like `debug`, soft deprecate it. PR-URL: #6161 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Brian White <[email protected]> Reviewed-By: Evan Lucas <[email protected]>
|
Landed in 236b7e8 |
There are more powerful loggers in user land like `debug`, soft deprecate it. PR-URL: nodejs#6161 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Brian White <[email protected]> Reviewed-By: Evan Lucas <[email protected]>
There are more powerful loggers in user land like `debug`, soft deprecate it. PR-URL: #6161 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Brian White <[email protected]> Reviewed-By: Evan Lucas <[email protected]>
Checklist
Affected core subsystem(s)
util
Description of change
There are more powerful loggers in user land like
debug, softdeprecate it.
see #4497 .