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.

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: ChildProcess links don't go to class documentation #36787

Closed
jmm opened this issue Jan 4, 2021 · 0 comments
Closed

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

jmm opened this issue Jan 4, 2021 · 0 comments
Labels
doc Issues and PRs related to the documentations.

Comments

@jmm
Copy link
Contributor

jmm commented Jan 4, 2021

📗 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.

@jmm jmm added the doc Issues and PRs related to the documentations. label Jan 4, 2021
jasnell added a commit to jasnell/node that referenced this issue Jan 4, 2021
Fixes: nodejs#36787
Signed-off-by: James M Snell <jasnell@gmail.com>
@jasnell jasnell closed this as completed in 760a6c8 Jan 6, 2021
danielleadams pushed a commit that referenced this issue Jan 12, 2021
Fixes: #36787
Signed-off-by: James M Snell <jasnell@gmail.com>

PR-URL: #36788
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
targos pushed a commit that referenced this issue May 1, 2021
Fixes: #36787
Signed-off-by: James M Snell <jasnell@gmail.com>

PR-URL: #36788
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant