GitHub user dongjinleekr opened a pull request:
https://github.com/apache/spark/pull/16830
[MINOR][CORE] Fix incorrect documentation of WritableConverter
## What changes were proposed in this pull request?
`WritableConverter` and `WritableFactory` work in opposite directions. But
both of them are documented with same description:
> A class encapsulating how to convert some type T to Writable. It stores
both the Writable class corresponding to T (e.g. IntWritable for Int) and a
function for doing the conversion.
This error is a result of commit d37978d, which resolves
[SPARK-4795](https://issues.apache.org/jira/browse/SPARK-4795) by redesigning
the "primitive type => Writable" implicit APIs.
This PR fix the documentation of `WritableConverter`.
## How was this patch tested?
Existing tests (no functional change anyway)
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/dongjinleekr/spark
feature/fix-writableconverter-doc
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/spark/pull/16830.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #16830
----
commit 6c04422d7ec343ba6766980e5fa9985e27659de8
Author: Lee Dongjin <dong...@apache.org>
Date: 2017-02-07T11:23:02Z
Fix documentation of WritableConverter
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org
