[
https://issues.apache.org/jira/browse/AVRO-1329?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17103989#comment-17103989
]
Felix GV edited comment on AVRO-1329 at 5/11/20, 1:06 AM:
----------------------------------------------------------
Order is definitely important in the already-existing symbols array, but that
does not necessarily mean that the metadata collection need be ordered in the
same way (i.e. as a parallel array) nor that it meeds to be dense (i.e. a map
structure keyed by symbol name would allow documenting only some of the
symbols, just like record field documentation today).
It is valid to design the metadata as a parallel array, of course, but
regardless of the metadata shape, I assume the spec would instruct
implementations to use the ordinal corresponding to the symbols array index.
was (Author: felixgv):
Order is definitely important in the already-existing symbols array, but that
does not necessarily mean that the metadata collection need be ordered in the
same way (i.e. as a parallel array) nor that it meeds to be dense (i.e. a map
structure keyed by symbol name would allow documenting only some of the fields,
just like record field documentation today).
It is valid to design the metadata as a parallel array, of course, but
regardless of the metadata shape, I assume the spec would instruct
implementations to use the ordinal corresponding to the symbols array index.
> Get per-symbol doc for enums
> ----------------------------
>
> Key: AVRO-1329
> URL: https://issues.apache.org/jira/browse/AVRO-1329
> Project: Apache Avro
> Issue Type: Improvement
> Components: doc
> Affects Versions: 1.7.4
> Reporter: Felix GV
> Priority: Minor
>
> It would be nice to have the ability to add documentation for each symbol of
> an enum.
> Doug Cutting, quoted from the mailing list:
> Documentation per enum symbol is not currently supported, but would not be
> difficult to add. Please file an issue in Jira if you'd like to see this. For
> compatibility, in Json, this would probably appear as a parallel array of
> documentation strings, e.g., something like:
> ("name": "Foo", "type":"enum", "doc":"an enum", "symbols":["X","Y"],
> "symbols-doc":["X is X", "Y is Y"]}
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
