You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beam.apache.org by "Davor Bonaci (JIRA)" <ji...@apache.org> on 2017/08/24 21:02:00 UTC
[jira] [Assigned] (BEAM-1448) Coder encode/decode context
documentation is lacking
[ https://issues.apache.org/jira/browse/BEAM-1448?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Davor Bonaci reassigned BEAM-1448:
----------------------------------
Assignee: (was: Davor Bonaci)
> Coder encode/decode context documentation is lacking
> ----------------------------------------------------
>
> Key: BEAM-1448
> URL: https://issues.apache.org/jira/browse/BEAM-1448
> Project: Beam
> Issue Type: Bug
> Components: sdk-java-core
> Reporter: Aviem Zur
> Labels: documentation
>
> Coder encode/decode context documentation is lacking.
> * Documentation of {{Coder}} methods {{encode}} and {{decode}} should include description of {{context}} argument and explain how to relate to it when implementing.
> * Consider renaming the static {{Context}} values {{NESTED}} and {{OUTER}} to more accurate names.
> * Emphasize the use of CoderProperties as the best way to test a coder.
> [Original dev list discussion|https://lists.apache.org/thread.html/fbd2d6b869ac2b0225ec39461b14158a03f304a930782d39ac9a60a6@%3Cdev.beam.apache.org%3E]
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)