pitrou commented on code in PR #466:
URL: https://github.com/apache/parquet-format/pull/466#discussion_r1841889654
##########
LogicalTypes.md:
##########
@@ -609,6 +609,17 @@ that is neither contained by a `LIST`- or `MAP`-annotated
group nor annotated
by `LIST` or `MAP` should be interpreted as a required list of required
elements where the element type is the type of the field.
+```
Review Comment:
I would suggest putting these examples, and the paragraph above, in a
separate subsection, for example:
````markdown
Implementations should use either `LIST` and `MAP` annotations _or_
unannotated
repeated fields, but not both. When using the annotations, no unannotated
repeated types are allowed.
### Unannotated repeated fields
A repeated field that is neither contained by a `LIST`- or `MAP`-annotated
group nor annotated by `LIST` or `MAP` should be interpreted as a
required list of required elements where the element type is the type of
the field.
```
// List<Integer> (non-null list, non-null elements)
repeated int32 num;
// List<Tuple<Integer, String>> (non-null list, non-null elements)
repeated group my_list {
required int32 num;
optional binary str (STRING);
}
```
It is heavily recommended that writers use either the LIST or MAP
annotations,
as outlined below, to make the intent clearer to readers.
````
--
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.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
