Skip to content

Commit 0890a2c

Browse files
authored
Update readme for geospatial crate (#9124)
# Which issue does this PR close? - Closes #8373. # Rationale for this change After #8943, columns with the extension type "geoarrow.wkb" are written as `Geometry` or `Geography` (depending on extension type metadata) when the `parquet` crate is built with the `geospatial` feature. I don't beleive there are any more implementation details we need to encapsulate in the `parquet-geospatial` crate to consider it "implemented" (although there may be more future utilities for which parquet-geospatial is a good home). # What changes are included in this PR? There is no need to duplicate the description in the issue here but it is sometimes worth providing a summary of the individual changes in this PR. # Are these changes tested? Documentation only! # Are there any user-facing changes? No!
1 parent 13c43c4 commit 0890a2c

1 file changed

Lines changed: 4 additions & 10 deletions

File tree

parquet-geospatial/README.md

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,27 +17,21 @@
1717
under the License.
1818
-->
1919

20-
# Apache Parquet Geometry/Geography Rust Implementation
20+
# Apache Parquet Geometry/Geography Rust Implementation Details
2121

2222
[![crates.io](https://img.shields.io/crates/v/parquet-geospatial.svg)](https://crates.io/crates/parquet-geospatial)
2323
[![docs.rs](https://img.shields.io/docsrs/parquet-geospatial.svg)](https://docs.rs/parquet/latest/parquet-geospatial/)
2424

25-
This crate contains an implementation of [Geometry and Geography Encoding] from
26-
[Apache Parquet]. This software is developed as part of the [Apache Arrow] project.
25+
This crate contains implementation details for the [Geometry and Geography Encoding] from
26+
[Apache Parquet], including utilities for calculating geospatial column statistics and writing
27+
tests. This software is developed as part of the [Apache Arrow] project.
2728

2829
[Geometry and Geography Encoding]: https://github.com/apache/parquet-format/blob/master/Geospatial.md
2930
[Apache Parquet]: https://parquet.apache.org/
3031
[Apache Arrow]: https://arrow.apache.org/
3132

3233
Please see the [API documentation](https://docs.rs/parquet-geospatial/latest) for more details.
3334

34-
## 🚧 Work In Progress
35-
36-
NOTE: This crate is under active development and is not yet ready for production use.
37-
If you are interested in helping, you can find more information on the GitHub [Geometry issue]
38-
39-
[Geometry issue]: https://github.com/apache/arrow-rs/issues/8373
40-
4135
## License
4236

4337
Licensed under the Apache License, Version 2.0: <http://www.apache.org/licenses/LICENSE-2.0>.

0 commit comments

Comments
 (0)