sunchao commented on a change in pull request #9731:
URL: https://github.com/apache/arrow/pull/9731#discussion_r595706798
##########
File path: rust/parquet/README.md
##########
@@ -46,6 +46,15 @@ while let Some(record) = iter.next() {
```
See [crate documentation](https://docs.rs/crate/parquet/4.0.0-SNAPSHOT) on
available API.
+## Upgrading from versions prior to 4.0
+
+*Upgrade Note*: If you used version 3.0 or previous of this crate, you
+likely need to change your code to refer to [`ConvertedType`] rather
+than [`LogicalType`]. Version 4.0 introduces an *entirely new* struct
+called `LogicalType` to align with the standard, and `LogicalType` was
Review comment:
nit: to align with the standard -> to align with the `LogicalType`
introduced in Parquet Format 2.4.0 and up.
##########
File path: rust/parquet/src/basic.rs
##########
@@ -156,6 +158,12 @@ pub enum ConvertedType {
// Mirrors `parquet::LogicalType`
/// Logical types used by version 2 of the Parquet format.
+///
+/// *Upgrade Note*: This is an *entirely new* struct as of version
Review comment:
I'm not sure if its useful to have this message here as well. Maybe the
one in README is enough?
##########
File path: rust/parquet/README.md
##########
@@ -46,6 +46,15 @@ while let Some(record) = iter.next() {
```
See [crate documentation](https://docs.rs/crate/parquet/4.0.0-SNAPSHOT) on
available API.
+## Upgrading from versions prior to 4.0
+
+*Upgrade Note*: If you used version 3.0 or previous of this crate, you
Review comment:
nit: remove `*Upgrade Note*`? it looks redundant.
##########
File path: rust/parquet/README.md
##########
@@ -46,6 +46,15 @@ while let Some(record) = iter.next() {
```
See [crate documentation](https://docs.rs/crate/parquet/4.0.0-SNAPSHOT) on
available API.
+## Upgrading from versions prior to 4.0
Review comment:
It's fine to add this temporarily in README.md but I think we should put
them this alongside other breaking changes from 4.0 (seems there're quite a few
of them) in a separate doc eventually. [Something
similar](https://github.com/apache/spark/blob/master/docs/sql-migration-guide.md)
from Apache Spark.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
