diff options
author | Xiangrui Meng <meng@databricks.com> | 2015-08-12 14:28:23 -0700 |
---|---|---|
committer | Xiangrui Meng <meng@databricks.com> | 2015-08-12 14:28:23 -0700 |
commit | 6f60298b1d7aa97268a42eca1e3b4851a7e88cb5 (patch) | |
tree | 8bf347f4c7c9dc3cb6755c4809a0dfbc3a36bd20 /python/pyspark/tests.py | |
parent | 551def5d6972440365bd7436d484a67138d9a8f3 (diff) | |
download | spark-6f60298b1d7aa97268a42eca1e3b4851a7e88cb5.tar.gz spark-6f60298b1d7aa97268a42eca1e3b4851a7e88cb5.tar.bz2 spark-6f60298b1d7aa97268a42eca1e3b4851a7e88cb5.zip |
[SPARK-8967] [DOC] add Since annotation
Add `Since` as a Scala annotation. The benefit is that we can use it without having explicit JavaDoc. This is useful for inherited methods. The limitation is that is doesn't show up in the generated Java API documentation. This might be fixed by modifying genjavadoc. I think we could leave it as a TODO.
This is how the generated Scala doc looks:
`since` JavaDoc tag:
![screen shot 2015-08-11 at 10 00 37 pm](https://cloud.githubusercontent.com/assets/829644/9230761/fa72865c-40d8-11e5-807e-0f3c815c5acd.png)
`Since` annotation:
![screen shot 2015-08-11 at 10 00 28 pm](https://cloud.githubusercontent.com/assets/829644/9230764/0041d7f4-40d9-11e5-8124-c3f3e5d5b31f.png)
rxin
Author: Xiangrui Meng <meng@databricks.com>
Closes #8131 from mengxr/SPARK-8967.
Diffstat (limited to 'python/pyspark/tests.py')
0 files changed, 0 insertions, 0 deletions