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.

Sign up for GitHub

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

Jump to bottom

Proposal: add API doc URL links in docstrings #1323

Open
wch opened this issue Apr 18, 2024 · 0 comments
Open

Proposal: add API doc URL links in docstrings #1323

wch opened this issue Apr 18, 2024 · 0 comments

Comments

@wch
Copy link
Collaborator

wch commented Apr 18, 2024

When writing app code, I often hover over a function and really want to see an example of it in use.

It would be useful if the docstrings had links to the corresponding API doc page on the web, because the web pages are easier to read and have live examples.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@wch