I think I get what you're trying to explain in this note, but the grammer is a
little bit awkward. I'd like to suggest this to make it sound more natural:
```
* <h3>Note on Data Encoding</h3>
*
* <p>Some form of data encoding is required when using custom types in a
CombineFn which do not
* have well-known coders. The sample code above uses a custom Accumulator
which it encodes by
* making it {@code java.io.Serializable}. However in cases where {@code
java.io.Serializable} is
* not efficient or applicable, there are two alternatives for encoding:
*
* <ul>
* <li>Generic coder class: Implement a coder class explicitly and use the
{@code @DefaultCoder}
* tag.
* <li>CombineFn specific way: While extending CombineFn, overwrite both
{@link
* #getAccumulatorCoder} and {@link #getDefaultOutputCoder}.
* </ul>
```
If any parts of that sound incorrect feel free to fix.
Also, although I can review the writing in this documentation change, I can't
really review the correctness of it since I'm not very familiar with coders. I
would recommend adding a reviewer who is familiar with coders and can vet that
this is correct. Maybe lukecwik since he's also a committer and can also take
care of merging.
[ Full content available at: https://github.com/apache/beam/pull/6439 ]
This message was relayed via gitbox.apache.org for [email protected]
