spark-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Sean Owen (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (SPARK-18615) Switch to multi-line doc to avoid a genjavadoc bug for backticks
Date Fri, 09 Dec 2016 00:55:58 GMT

     [ https://issues.apache.org/jira/browse/SPARK-18615?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Sean Owen updated SPARK-18615:
------------------------------
    Assignee: Hyukjin Kwon

> 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
>            Assignee: Hyukjin Kwon
>            Priority: Minor
>             Fix For: 2.1.0
>
>
> 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: issues-unsubscribe@spark.apache.org
For additional commands, e-mail: issues-help@spark.apache.org


Mime
View raw message