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

Add "Go to Source" link in api-docs (per method) #1695

Closed
ST-DDT opened this issue Dec 27, 2022 · 2 comments · Fixed by #1780
Closed

Add "Go to Source" link in api-docs (per method) #1695

ST-DDT opened this issue Dec 27, 2022 · 2 comments · Fixed by #1780
Assignees
Labels
c: docs Improvements or additions to documentation p: 1-normal Nothing urgent s: needs decision Needs team/maintainer decision
Milestone

Comments

@ST-DDT
Copy link
Member

ST-DDT commented Dec 27, 2022

Clear and concise description of the problem

Some users might wish to read the sources of a method instead of the documentation.

Suggested solution

Add a link to navigate to the source code of a method.

grafik

Alternative

No response

Additional context

Accessible via signature.sources[0?].{filename, line, url}

@ST-DDT ST-DDT added c: docs Improvements or additions to documentation p: 1-normal Nothing urgent s: needs decision Needs team/maintainer decision labels Dec 27, 2022
@Shinigami92
Copy link
Member

Cool 👍

VueUse also has something like this: https://vueuse.org/shared/createGlobalState/#source

@ST-DDT ST-DDT self-assigned this Jan 25, 2023
@ST-DDT
Copy link
Member Author

ST-DDT commented Jan 25, 2023

PR created: #1780

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: docs Improvements or additions to documentation p: 1-normal Nothing urgent s: needs decision Needs team/maintainer decision
Projects
No open projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants