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

No way to get to the examples from docs.rs #186

Closed
alamb opened this issue Apr 26, 2021 · 1 comment · Fixed by #457
Closed

No way to get to the examples from docs.rs #186

alamb opened this issue Apr 26, 2021 · 1 comment · Fixed by #457
Labels
datafusion Changes in the datafusion crate documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@alamb
Copy link
Contributor

alamb commented Apr 26, 2021

Note: migrated from original JIRA: https://issues.apache.org/jira/browse/ARROW-11863

https://docs.rs/datafusion/3.0.0/datafusion/ has a tantalizing piece of text about the examples, but no link or explanation of how to find them

!Screen Shot 2021-03-04 at 2.51.54 PM.png!

The examples are at https://github.com/apache/arrow/tree/master/rust/datafusion/examples

The ideal outcome would be to point people somehow at the examples directory for the version of the docs they are looking at in docs.rs. The ok, outcome would be to point the docs from docs.rs always at master.

@alamb alamb added the datafusion Changes in the datafusion crate label Apr 26, 2021
@alamb
Copy link
Contributor Author

alamb commented Apr 26, 2021

Comment from Daniël Heres(Dandandan) @ 2021-03-22T17:30:12.744+0000:

An url based on the version would also be cool, for example:

https://github.com/apache/arrow/tree/apache-arrow-3.0.0/rust/datafusion/examples

@andygrove andygrove added documentation Improvements or additions to documentation good first issue Good for newcomers labels May 1, 2021
@alamb alamb closed this as completed in #457 Jun 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
datafusion Changes in the datafusion crate documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants