You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by tu...@apache.org on 2023/06/30 11:15:26 UTC
[arrow-rs] branch master updated: Docs: Add clearer API doc links (#4461)
This is an automated email from the ASF dual-hosted git repository.
tustvold pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow-rs.git
The following commit(s) were added to refs/heads/master by this push:
new 666764666 Docs: Add clearer API doc links (#4461)
666764666 is described below
commit 6667646660fb0f3248b3cb02e77d89f1ac4f3cf2
Author: Andrew Lamb <an...@nerdnetworks.org>
AuthorDate: Fri Jun 30 07:15:21 2023 -0400
Docs: Add clearer API doc links (#4461)
* Docs: Add clearer API doc links
* prettier
---
README.md | 16 ++++++++--------
arrow-flight/README.md | 4 ++++
arrow/README.md | 4 +++-
parquet/README.md | 4 +++-
4 files changed, 18 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md
index 53220620a..c3108917e 100644
--- a/README.md
+++ b/README.md
@@ -25,14 +25,14 @@ Welcome to the implementation of Arrow, the popular in-memory columnar format, i
This repo contains the following main components:
-| Crate | Description | Documentation |
-| ------------ | ------------------------------------------------------------------------- | ------------------------------ |
-| arrow | Core functionality (memory layout, arrays, low level computations) | [(README)][arrow-readme] |
-| parquet | Support for Parquet columnar file format | [(README)][parquet-readme] |
-| arrow-flight | Support for Arrow-Flight IPC protocol | [(README)][flight-readme] |
-| object-store | Support for object store interactions (aws, azure, gcp, local, in-memory) | [(README)][objectstore-readme] |
-
-See the list of all crates in this repo and their rustdocs [here](https://arrow.apache.org/rust).
+| Crate | Description | Latest API Docs | README |
+| ------------ | ------------------------------------------------------------------------- | ---------------------------------------------- | ------------------------------ |
+| arrow | Core functionality (memory layout, arrays, low level computations) | [docs.rs](https://docs.rs/arrow/latest) | [(README)][arrow-readme] |
+| parquet | Support for Parquet columnar file format | [docs.rs](https://docs.rs/parquet/latest) | [(README)][parquet-readme] |
+| arrow-flight | Support for Arrow-Flight IPC protocol | [docs.rs](https://docs.rs/arrow-flight/latest) | [(README)][flight-readme] |
+| object-store | Support for object store interactions (aws, azure, gcp, local, in-memory) | [docs.rs](https://docs.rs/object_store/latest) | [(README)][objectstore-readme] |
+
+The current development version the API documentation in this repo can be found [here](https://arrow.apache.org/rust).
There are two related crates in a different repository
diff --git a/arrow-flight/README.md b/arrow-flight/README.md
index d4fddba70..9194b209f 100644
--- a/arrow-flight/README.md
+++ b/arrow-flight/README.md
@@ -21,6 +21,10 @@
[](https://crates.io/crates/arrow-flight)
+See the [API documentation](https://docs.rs/arrow_flight/latest) for examples and the full API.
+
+The API documentation for most recent, unreleased code is available [here](https://arrow.apache.org/rust/arrow_flight/index.html).
+
## Usage
Add this to your Cargo.toml:
diff --git a/arrow/README.md b/arrow/README.md
index adf32ff61..fb2119e3b 100644
--- a/arrow/README.md
+++ b/arrow/README.md
@@ -24,9 +24,11 @@
This crate contains the official Native Rust implementation of [Apache Arrow][arrow] in memory format, governed by the Apache Software Foundation.
-The [crate documentation](https://arrow.apache.org/rust/arrow/index.html) contains examples and full API.
+The [API documentation](https://docs.rs/arrow/latest) contains examples and full API.
There are several [examples](https://github.com/apache/arrow-rs/tree/master/arrow/examples) to start from as well.
+The API documentation for most recent, unreleased code is available [here](https://arrow.apache.org/rust/arrow/index.html).
+
## Rust Version Compatibility
This crate is tested with the latest stable version of Rust. We do not currently test against other, older versions.
diff --git a/parquet/README.md b/parquet/README.md
index 19f34fd87..86c7ee2c3 100644
--- a/parquet/README.md
+++ b/parquet/README.md
@@ -24,7 +24,9 @@
This crate contains the official Native Rust implementation of [Apache Parquet](https://parquet.apache.org/), which is part of the [Apache Arrow](https://arrow.apache.org/) project.
-See [crate documentation](https://arrow.apache.org/rust/parquet/index.html) for examples and the full API.
+See the [API documentation](https://docs.rs/parquet/latest) for examples and the full API.
+
+The API documentation for most recent, unreleased code is available [here](https://arrow.apache.org/rust/parquet/index.html).
## Rust Version Compatibility