[jira] [Commented] (BEAM-1448) Coder encode/decode context documentation is lacking

["Kenneth Knowles (Jira)" <ji...@apache.org>]

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

Kenneth Knowles commented on BEAM-1448:
---------------------------------------

This issue has been migrated to https://github.com/apache/beam/issues/18184

> 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
>            Priority: P3
>              Labels: Clarified, 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
(v8.20.7#820007)