You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@avro.apache.org by "Vibha Rathi (JIRA)" <ji...@apache.org> on 2014/08/18 22:35:21 UTC
[jira] [Commented] (AVRO-1329) Get per-symbol doc for enums
[ https://issues.apache.org/jira/browse/AVRO-1329?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14101230#comment-14101230 ]
Vibha Rathi commented on AVRO-1329:
-----------------------------------
Agree that this would be great to have.
> Get per-symbol doc for enums
> ----------------------------
>
> Key: AVRO-1329
> URL: https://issues.apache.org/jira/browse/AVRO-1329
> Project: 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.
> 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"]}
--
This message was sent by Atlassian JIRA
(v6.2#6252)