[
https://issues.apache.org/jira/browse/AVRO-1329?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Felix GV updated AVRO-1329:
---------------------------
Description:
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"]}
was:
It would be nice to have the ability to add documentation for each symbol of an
enum.
Doung 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"]}
> 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)
