Skip to content

doc: improve child process synchronous API docs #39306

Closed
@evanshortiss

Description

@evanshortiss

📗 API Reference Docs Problem

  • Version: 14+
  • Platform: N/A
  • Subsystem: Child Process

Location

Section of the site where the content exists

Affected URL(s):

Description

Concise explanation of the problem

I'd like to suggest the following improvements to synchronous child process docs:

  • The options.stdio argument should provide a link to the docs for that option (this is under the async spawn doc)
  • Basic usage example(s)
  • Exception handling example to demonstrate:
    • That stderr and stdio are attached to the error raised if a child exits with a none-zero code
    • That stderr and stdio are not attached to the error if options.stdio is set to ignore etc.

  • I would like to work on this issue and
    submit a pull request.

Metadata

Metadata

Assignees

No one assigned

    Labels

    child_processIssues and PRs related to the child_process subsystem.docIssues and PRs related to the documentations.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions