docs: add documentation for process.traceProcessWarnings #53641
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nodejs-github-bot
added
doc
AlirezaEbrahimkhani
force-pushed
the
docs/traceProcessWarnings
branch
from
021aa19 to
1d1c74b
Compare
avivkeller
reviewed
Jun 30, 2024
doc/api/process.md
Outdated
| ## `process.traceProcessWarnings` | ||
|
|
||
| <!-- YAML | ||
| added: v6.x |
There was a problem hiding this comment.
This should be the exact version, rather than the .x semver
doc/api/process.md
Outdated
Comment on lines
3838
to
3840
| The `process.traceProcessWarnings` property indicates whether the `--trace-warnings` flag is set on the current Node.js process. This property allows programmatic control over the tracing of warnings, enabling or disabling stack traces for warnings at runtime. | ||
|
|
||
| Setting this property to `true` enables the tracing of warnings, akin to launching the process with the `--trace-warnings` command-line option. Conversely, setting it to `false` disables the tracing. |
There was a problem hiding this comment.
I think this can be condensed, as some information is repeated (such as what the API does)
AlirezaEbrahimkhani
force-pushed
the
docs/traceProcessWarnings
branch
from
1d1c74b to
f83063f
Compare
avivkeller
reviewed
Jul 4, 2024
doc/api/process.md
Outdated
|
|
||
| The `process.traceProcessWarnings` property indicates whether the `--trace-warnings` flag is set on the current Node.js process. This property allows programmatic control over the tracing of warnings, enabling or disabling stack traces for warnings at runtime. | ||
|
|
||
| ```mjs |
There was a problem hiding this comment.
This should be a js block, not mjs.
|
@redyetidev |
AlirezaEbrahimkhani
force-pushed
the
docs/traceProcessWarnings
branch
from
f83063f to
bb1000d
Compare
jasnell
reviewed
Jul 4, 2024
doc/api/process.md
Outdated
|
|
||
| * {boolean} | ||
|
|
||
| The `process.traceProcessWarnings` property indicates whether the `--trace-warnings` flag is set on the current Node.js process. This property allows programmatic control over the tracing of warnings, enabling or disabling stack traces for warnings at runtime. |
There was a problem hiding this comment.
Suggested change
| The `process.traceProcessWarnings` property indicates whether the `--trace-warnings` flag is set on the current Node.js process. This property allows programmatic control over the tracing of warnings, enabling or disabling stack traces for warnings at runtime. | |
| The `process.traceProcessWarnings` property indicates whether the `--trace-warnings` flag | |
| is set on the current Node.js process. This property allows programmatic control over the | |
| tracing of warnings, enabling or disabling stack traces for warnings at runtime. |
There was a problem hiding this comment.
Thanks for pointing this out and I made the change you have requested.
AlirezaEbrahimkhani
force-pushed
the
docs/traceProcessWarnings
branch
from
bb1000d to
d647636
Compare
|
@jasnell Could you please check and review this PR again when you have a moment? Thanks |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add documentation for the
process.traceProcessWarningsproperty in the process module. This property allows for programmatic control of warning trace settings in Node.js applications and was previously undocumented despite being available since Node.js v6.x.resolves #53514