Skip to content

doc: ChildProcess links don't go to class documentation #36787

Closed
@jmm

Description

@jmm

📗 API Reference Docs Problem

ChildProcess links don't go to class documentation

  • Version: 12, perhaps others

Location

Section of the site where the content exists

Affected URL(s):

Description

It seems unhelpful that the links to ChildProcess in the prose go to the module documentation. I'd expect them to link to the "Class: ChildProcess" documentation.

For example, the documentation for child_process.fork includes this:

Like [`child_process.spawn()`][], a [`ChildProcess`][] object is returned. 

Which links to https://nodejs.org/docs/latest-v12.x/api/child_process.html#child_process_child_process -- the top of the module documentation.

Whereas the link in the method signature documentation ("Returns: <ChildProcess>") goes to the class: https://nodejs.org/docs/latest-v12.x/api/child_process.html#child_process_class_childprocess .

I'd expect both to go to the class documentation.

There are also instances in the documentation where ChildProcess is referenced and formatted as code without being linked, FWIW.

Metadata

Metadata

Assignees

No one assigned

    Labels

    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