Docs: Add clearer API doc links #4461
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
arrow
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which issue does this PR close?
Follow on to #4436 from @xxchan
Rationale for this change
I think we should be directing people to the published version of the docs on docs.rs rather than the unreleased API by default. The unreleased API is now available at https://arrow.apache.org/rust/ thanks to @xxchan ❤️
What changes are included in this PR?
Add some links to try and drive people to the docs.rs (released) version of the docs
Are there any user-facing changes?
README is different. See rendered version here: https://github.com/alamb/arrow-rs/tree/alamb/doc_links