[SPARK-18615][DOCS] Switch to multi-line doc to avoid a genjavadoc bug for backticks #16050
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I guess this might not cause conflicts with #16013. |
|
cc @srowen do you mind if I ask to take a look please? |
|
Test build #69285 has finished for PR 16050 at commit
|
srowen
approved these changes
Nov 29, 2016
|
Merged to master/2.1 |
asfgit
pushed a commit
that referenced
this pull request
Nov 29, 2016
…g for backticks
## What changes were proposed in this pull request?
Currently, single line comment does not mark down backticks to `<code>..</code>` but prints as they are (`` `..` ``). For example, the line below:
```scala
/** Return an RDD with the pairs from `this` whose keys are not in `other`. */
```
So, we could work around this as below:
```scala
/**
* Return an RDD with the pairs from `this` whose keys are not in `other`.
*/
```
- javadoc
- **Before**
- **After**
- scaladoc (this one looks fine either way)
- **Before**
- **After**
I suspect this is related with SPARK-16153 and genjavadoc issue in ` lightbend/genjavadoc#85`.
## How was this patch tested?
I found them via
```
grep -r "\/\*\*.*\`" . | grep .scala
````
and then checked if each is in the public API documentation with manually built docs (`jekyll build`) with Java 7.
Author: hyukjinkwon <[email protected]>
Closes #16050 from HyukjinKwon/javadoc-markdown.
(cherry picked from commit 1a87009)
Signed-off-by: Sean Owen <[email protected]>
robert3005
pushed a commit
to palantir/spark
that referenced
this pull request
Dec 2, 2016
…g for backticks
## What changes were proposed in this pull request?
Currently, single line comment does not mark down backticks to `<code>..</code>` but prints as they are (`` `..` ``). For example, the line below:
```scala
/** Return an RDD with the pairs from `this` whose keys are not in `other`. */
```
So, we could work around this as below:
```scala
/**
* Return an RDD with the pairs from `this` whose keys are not in `other`.
*/
```
- javadoc
- **Before**
- **After**
- scaladoc (this one looks fine either way)
- **Before**
- **After**
I suspect this is related with SPARK-16153 and genjavadoc issue in ` lightbend/genjavadoc#85`.
## How was this patch tested?
I found them via
```
grep -r "\/\*\*.*\`" . | grep .scala
````
and then checked if each is in the public API documentation with manually built docs (`jekyll build`) with Java 7.
Author: hyukjinkwon <[email protected]>
Closes apache#16050 from HyukjinKwon/javadoc-markdown.
uzadude
pushed a commit
to uzadude/spark
that referenced
this pull request
Jan 27, 2017
…g for backticks
## What changes were proposed in this pull request?
Currently, single line comment does not mark down backticks to `<code>..</code>` but prints as they are (`` `..` ``). For example, the line below:
```scala
/** Return an RDD with the pairs from `this` whose keys are not in `other`. */
```
So, we could work around this as below:
```scala
/**
* Return an RDD with the pairs from `this` whose keys are not in `other`.
*/
```
- javadoc
- **Before**
- **After**
- scaladoc (this one looks fine either way)
- **Before**
- **After**
I suspect this is related with SPARK-16153 and genjavadoc issue in ` lightbend/genjavadoc#85`.
## How was this patch tested?
I found them via
```
grep -r "\/\*\*.*\`" . | grep .scala
````
and then checked if each is in the public API documentation with manually built docs (`jekyll build`) with Java 7.
Author: hyukjinkwon <[email protected]>
Closes apache#16050 from HyukjinKwon/javadoc-markdown.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What changes were proposed in this pull request?
Currently, single line comment does not mark down backticks to
<code>..</code>but prints as they are (`..`). For example, the line below:/** Return an RDD with the pairs from `this` whose keys are not in `other`. */So, we could work around this as below:
javadoc
Before
After
scaladoc (this one looks fine either way)
Before
After
I suspect this is related with SPARK-16153 and genjavadoc issue in
typesafehub/genjavadoc#85.How was this patch tested?
I found them via
and then checked if each is in the public API documentation with manually built docs (
jekyll build) with Java 7.