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

docs: show source of documented functions #569

Merged
merged 1 commit into from
Oct 15, 2023
Merged

docs: show source of documented functions #569

merged 1 commit into from
Oct 15, 2023

Conversation

rok
Copy link
Contributor

@rok rok commented Oct 15, 2023

Proposal to resolve #563.
This globally sets show_source: true (per file setting is also possible, see here.
Example of how docs would look:
image
Expanded:
image

@rok
Copy link
Contributor Author

rok commented Oct 15, 2023 •
edited
Loading

For completeness, as per SO there currently isn't a good option to link to github source. However mkdocstring provides a show_source setting that will display the function's source. This might not be as useful and we might prefer to look into improving out template or something along those lines to provide an actual link to the source. As proposed solution is much easier I'm proposing it first.

@changhiskhan changhiskhan merged commit 043e388 into main Oct 15, 2023
5 checks passed
@changhiskhan changhiskhan deleted the api_docs_source branch October 15, 2023 16:05
raghavdixit99 pushed a commit to raghavdixit99/lancedb that referenced this pull request Apr 5, 2024
@rok
docs: show source of documented functions (lancedb#569)
7fd50ef
westonpace pushed a commit that referenced this pull request Apr 5, 2024
@rok @westonpace
docs: show source of documented functions (#569)
b10afbe
alexkohler pushed a commit to alexkohler/lancedb that referenced this pull request Apr 20, 2024
@changhiskhan
Update duckdb version. Closes lancedb#569 (lancedb#571)
6cc5865 
* Update duckdb version. Closes lancedb#569

Starting v0.7, duckdb supports lazy lance dataset.
ListVector is also exposed via C API.

* Move submodules to v0.7.0 for duckdb

* address comments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AyushExel AyushExel AyushExel approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

API docs should link back to the source code on github
3 participants
@rok @AyushExel @changhiskhan