beam-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Jesse Anderson (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (BEAM-232) Update AvroIO JavaDoc to Mention Registering Coder
Date Tue, 03 May 2016 15:58:12 GMT

    [ https://issues.apache.org/jira/browse/BEAM-232?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15268938#comment-15268938
] 

Jesse Anderson commented on BEAM-232:
-------------------------------------

I can understand your POV and feel free to close it.

The RuntimeException's stack trace comes through AvroIO. People will come looking at this
class first if they don't understand registering a coder. Their searches will take them to
this class' JavaDocs which don't mention the issue.

Maybe the JavaDoc needs a requirements section with a note like:
{quote}
Note: Every PCollection has to have a coder, including the output PCollection of AvroIO. You
will need to register your Avro class.
{quote}

> Update AvroIO JavaDoc to Mention Registering Coder
> --------------------------------------------------
>
>                 Key: BEAM-232
>                 URL: https://issues.apache.org/jira/browse/BEAM-232
>             Project: Beam
>          Issue Type: Bug
>          Components: sdk-java-core
>            Reporter: Jesse Anderson
>            Assignee: Davor Bonaci
>
> The AvroIO docs say:
> {quote}To read specific records, such as Avro-generated classes, provide an Avro-generated
class type.{quote}
> They don't mention that you need to register a coder in order for the specific records
class to not get a RuntimeException.
> The JavaDocs should be update to say you need to register and the code snippets in the
JavaDocs should be updated to at least mention this.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message