Add some (but not all) docs for the Rust crate

Cargo.toml

@@ -155,6 +155,7 @@ bench = false                               # TODO fix this benchmark
 required-features = ["parquet_compression"]
 
 [package.metadata.docs.rs]
+rustdoc-args = ["--cfg", "docsrs"]
 features = [
   "csv",
   "flatgeobuf",

README.md

@@ -1,4 +1,9 @@
-# `geoarrow-rs`
+# geoarrow-rs
+
+[![GitHub Workflow Status (CI)](https://img.shields.io/github/actions/workflow/status/geoarrow/geoarrow-rs/ci.yml?branch=main&style=for-the-badge)](https://github.com/geoarrow/geoarrow-rs/actions/workflows/ci.yml)
+[![docs.rs](https://img.shields.io/docsrs/geoarrow?style=for-the-badge&label=docs.rs)](https://docs.rs/geoarrow/latest/geoarrow/)
+[![Crates.io](https://img.shields.io/crates/v/geoarrow?style=for-the-badge)](https://crates.io/crates/geoarrow)
+![Crates.io](https://img.shields.io/crates/l/geoarrow?style=for-the-badge)
 
 A Rust implementation of the [GeoArrow](https://github.com/geoarrow/geoarrow) specification and bindings to [GeoRust algorithms](https://github.com/georust/geo) for efficient spatial operations on GeoArrow memory.
 
@@ -20,7 +25,7 @@ This repository also includes [Python bindings](https://github.com/geoarrow/geoa
 Add this to your `Cargo.toml`:
 
 ```toml
-geoarrow = "0.1"
+geoarrow = "0.2"
 ```
 
 ## References

js/README.md

@@ -1,4 +1,6 @@
-# `geoarrow-wasm`
+# geoarrow-wasm
+
+[![GitHub Workflow Status (WASM)](https://img.shields.io/github/actions/workflow/status/geoarrow/geoarrow-rs/wasm.yml?label=WASM&branch=main&style=for-the-badge)](https://github.com/geoarrow/geoarrow-rs/actions/workflows/wasm.yml)
 
 Efficient, vectorized geospatial operations in WebAssembly.
 
@@ -21,7 +23,6 @@ I wrote a [blog post](https://kylebarron.dev/blog/geos-wasm) about this that goe
 
 Most users will use this by installing the prebuilt JavaScript package. This is published to NPM as [`geoarrow-wasm`](https://npmjs.com/package/geoarrow-wasm).
 
-
 ### From Rust
 
 Advanced users can also depend on these Rust-Wasm bindings directly, enabling you to add custom operations on top of these bindings and generating your own WebAssembly bundles. This means you can reuse all the binding between JavaScript and WebAssembly and focus on implementing your algorithms. This package is published to crates.io as [`geoarrow-wasm`](https://crates.io/crates/geoarrow-wasm).
@@ -31,5 +32,3 @@ Advanced users can also depend on these Rust-Wasm bindings directly, enabling yo
 - [Prototyping GeoRust + GeoArrow in WebAssembly](https://observablehq.com/@kylebarron/prototyping-georust-geoarrow-in-webassembly)
 
 ## How it Works
-
-

python/README.md

@@ -1,4 +1,6 @@
-# `geoarrow.rust`: Python bindings to `geoarrow-rs`
+# geoarrow.rust
+
+[![GitHub Workflow Status (Python)](https://img.shields.io/github/actions/workflow/status/geoarrow/geoarrow-rs/python.yml?branch=main&style=for-the-badge)](https://github.com/geoarrow/geoarrow-rs/actions/workflows/python.yml)
 
 This folder contains Python bindings to the [GeoArrow Rust implementation](https://github.com/geoarrow/geoarrow-rs).
 

src/algorithm/mod.rs

@@ -1,5 +1,7 @@
 //! Vectorized algorithms implemented on and returning GeoArrow arrays.
 
+#![allow(missing_docs)] // FIXME
+
 pub mod broadcasting;
 pub mod geo;
 pub mod geo_index;

src/array/coord/mod.rs

@@ -19,7 +19,10 @@ pub use separated::{SeparatedCoordBuffer, SeparatedCoordBufferBuilder};
 /// buffers as XXXX and YYYY.
 #[derive(Default, Debug, Clone, Copy, PartialEq, Eq, Hash)]
 pub enum CoordType {
+    /// Interleaved coordinates.
     #[default]
     Interleaved,
+
+    /// Separated coordinates.
     Separated,
 }

src/array/coord/separated/array.rs

@@ -20,7 +20,6 @@ pub struct SeparatedCoordBuffer<const D: usize> {
 }
 
 fn check<const D: usize>(buffers: &[ScalarBuffer<f64>; D]) -> Result<()> {
-    dbg!(buffers);
     if !buffers.windows(2).all(|w| w[0].len() == w[1].len()) {
         return Err(GeoArrowError::General(
             "all buffers must have the same length".to_string(),

src/array/metadata.rs

@@ -12,6 +12,7 @@ use crate::error::GeoArrowError;
 /// this value is omitted, edges will be interpreted as planar.
 #[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
 pub enum Edges {
+    /// Follow a spherical path rather than a planar.
     #[serde(rename = "spherical")]
     Spherical,
 }

src/array/mod.rs

@@ -1,5 +1,7 @@
 //! Implementations of immutable GeoArrow arrays plus builders to more easily create arrays.
 
+#![allow(missing_docs)] // FIXME
+
 pub use binary::{WKBArray, WKBBuilder, WKBCapacity};
 pub use cast::{AsChunkedGeometryArray, AsGeometryArray};
 pub use coord::{