Hyukjin Kwon created SPARK-18615:
------------------------------------
Summary: Switch to multi-line doc to avoid a genjavadoc bug for
backticks
Key: SPARK-18615
URL: https://issues.apache.org/jira/browse/SPARK-18615
Project: Spark
Issue Type: Improvement
Components: Documentation
Reporter: Hyukjin Kwon
Priority: Minor
I suspect this is related with SPARK-16153 and genjavadoc issue in
https://github.com/typesafehub/genjavadoc/issues/85 but I am not too sure.
Currently, single line comment does not mark down backticks to
{{<code>..</code>}} but prints as they are. For example, the line below:
{code}
/** Return an RDD with the pairs from `this` whose keys are not in `other`. */
{code}
So, we could work around this as below:
{code}
/**
* Return an RDD with the pairs from `this` whose keys are not in `other`.
*/
{code}
Please refer the image in the pull request.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
