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: add links to source code in docs #33977

Closed
1 task done
aw-davidson opened this issue Jun 19, 2020 · 0 comments
Closed
1 task done

doc: add links to source code in docs #33977

aw-davidson opened this issue Jun 19, 2020 · 0 comments
Labels
doc Issues and PRs related to the documentations.

Comments

@aw-davidson
Copy link
Contributor

📗 API Reference Docs Problem

  • Version: N/A
  • Platform: N/A
  • Subsystem: N/A

Location

On every module docs page

Affected URL(s):

Problem description

It would be nice to have links to source code below the title of each module. For an example, look at pythons documentation for the heapq module: https://docs.python.org/3/library/heapq.html. So for node Buffer it would look like:

Buffer

Stability: 2 - Stable

Source Code: lib/buffer.js


  • I would like to work on this issue and submit a pull request.
@aw-davidson aw-davidson added the doc Issues and PRs related to the documentations. label Jun 19, 2020
aw-davidson added a commit to aw-davidson/node that referenced this issue Jun 24, 2020
MylesBorins pushed a commit that referenced this issue Jul 14, 2020
Fixes: #33977

PR-URL: #33996
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins pushed a commit that referenced this issue Jul 16, 2020
Fixes: #33977

PR-URL: #33996
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
addaleax pushed a commit that referenced this issue Sep 22, 2020
Fixes: #33977

PR-URL: #33996
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@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

No branches or pull requests

1 participant