{"action":"created","issue":{"url":"https://api.github.com/repos/apache/spark/issues/15889","repository_url":"https://api.github.com/repos/apache/spark","labels_url":"https://api.github.com/repos/apache/spark/issues/15889/labels{/name}","comments_url":"https://api.github.com/repos/apache/spark/issues/15889/comments","events_url":"https://api.github.com/repos/apache/spark/issues/15889/events","html_url":"https://github.com/apache/spark/pull/15889","id":189364728,"number":15889,"title":"[SPARK-18445][BUILD][DOCS] Fix the markdown for `Note:`/`NOTE:`/`Note that`/`'''Note:'''` across Scala/Java API documentation","user":{"login":"HyukjinKwon","id":6477701,"avatar_url":"https://avatars.githubusercontent.com/u/6477701?v=3","gravatar_id":"","url":"https://api.github.com/users/HyukjinKwon","html_url":"https://github.com/HyukjinKwon","followers_url":"https://api.github.com/users/HyukjinKwon/followers","following_url":"https://api.github.com/users/HyukjinKwon/following{/other_user}","gists_url":"https://api.github.com/users/HyukjinKwon/gists{/gist_id}","starred_url":"https://api.github.com/users/HyukjinKwon/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/HyukjinKwon/subscriptions","organizations_url":"https://api.github.com/users/HyukjinKwon/orgs","repos_url":"https://api.github.com/users/HyukjinKwon/repos","events_url":"https://api.github.com/users/HyukjinKwon/events{/privacy}","received_events_url":"https://api.github.com/users/HyukjinKwon/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":12,"created_at":"2016-11-15T11:16:34Z","updated_at":"2016-11-17T12:02:31Z","closed_at":null,"pull_request":{"url":"https://api.github.com/repos/apache/spark/pulls/15889","html_url":"https://github.com/apache/spark/pull/15889","diff_url":"https://github.com/apache/spark/pull/15889.diff","patch_url":"https://github.com/apache/spark/pull/15889.patch"},"body":"## What changes were proposed in this pull request?\r\n\r\nIt seems in Scala/Java,\r\n\r\n- `Note:`\r\n- `NOTE:`\r\n- `Note that`\r\n- `'''Note:'''`\r\n- `@note`\r\n\r\nThis PR proposes to fix those to `@note` to be consistent.\r\n\r\n**Before**\r\n\r\n- Scala\r\n  ![2016-11-17 6 16 39](https://cloud.githubusercontent.com/assets/6477701/20383180/1a7aed8c-acf2-11e6-9611-5eaf6d52c2e0.png)\r\n\r\n- Java\r\n  ![2016-11-17 6 14 41](https://cloud.githubusercontent.com/assets/6477701/20383096/c8ffc680-acf1-11e6-914a-33460bf1401d.png)\r\n\r\n\r\n**After**\r\n\r\n- Scala\r\n  ![2016-11-17 6 16 44](https://cloud.githubusercontent.com/assets/6477701/20383167/09940490-acf2-11e6-937a-0d5e1dc2cadf.png)\r\n\r\n- Java\r\n  ![2016-11-17 6 13 39](https://cloud.githubusercontent.com/assets/6477701/20383132/e7c2a57e-acf1-11e6-9c47-b849674d4d88.png)\r\n\r\n## How was this patch tested?\r\n\r\nThe notes were found via\r\n\r\n```bash\r\ngrep -r \"NOTE: \" . | \\ # Note:|NOTE:|Note that|'''Note:'''\r\ngrep -v \"// NOTE: \" | \\  # Starting with // does not appear in API documentation.\r\ngrep -E '.scala|.java' | \\ # java/scala files\r\ngrep -v Suite | \\ # exclude tests\r\ngrep -v Test | \\ # exclude tests\r\ngrep -e 'org.apache.spark.api.java' \\ # packages appear in API documenation\r\n-e 'org.apache.spark.api.java.function' \\\r\n-e 'org.apache.spark.api.r' \\\r\n...\r\n```\r\n\r\n```bash\r\ngrep -r \"Note that \" . | \\ # Note:|NOTE:|Note that|'''Note:'''\r\ngrep -v \"// Note that \" | \\  # Starting with // does not appear in API documentation.\r\ngrep -E '.scala|.java' | \\ # java/scala files\r\ngrep -v Suite | \\ # exclude tests\r\ngrep -v Test | \\ # exclude tests\r\ngrep -e 'org.apache.spark.api.java' \\ # packages appear in API documenation\r\n-e 'org.apache.spark.api.java.function' \\\r\n-e 'org.apache.spark.api.r' \\\r\n...\r\n```\r\n\r\n```bash\r\ngrep -r \"Note: \" . | \\ # Note:|NOTE:|Note that|'''Note:'''\r\ngrep -v \"// Note: \" | \\  # Starting with // does not appear in API documentation.\r\ngrep -E '.scala|.java' | \\ # java/scala files\r\ngrep -v Suite | \\ # exclude tests\r\ngrep -v Test | \\ # exclude tests\r\ngrep -e 'org.apache.spark.api.java' \\ # packages appear in API documenation\r\n-e 'org.apache.spark.api.java.function' \\\r\n-e 'org.apache.spark.api.r' \\\r\n...\r\n```\r\n\r\n```bash\r\ngrep -r \"'''Note:'''\" . | \\ # Note:|NOTE:|Note that|'''Note:'''\r\ngrep -v \"// '''Note:''' \" | \\  # Starting with // does not appear in API documentation.\r\ngrep -E '.scala|.java' | \\ # java/scala files\r\ngrep -v Suite | \\ # exclude tests\r\ngrep -v Test | \\ # exclude tests\r\ngrep -e 'org.apache.spark.api.java' \\ # packages appear in API documenation\r\n-e 'org.apache.spark.api.java.function' \\\r\n-e 'org.apache.spark.api.r' \\\r\n...\r\n```\r\n\r\nAnd then fixed one by one comparing with API documentation/access modifiers.\r\n\r\nAfter that, manually tested via `jekyll build`."},"comment":{"url":"https://api.github.com/repos/apache/spark/issues/comments/261230010","html_url":"https://github.com/apache/spark/pull/15889#issuecomment-261230010","issue_url":"https://api.github.com/repos/apache/spark/issues/15889","id":261230010,"user":{"login":"AmplabJenkins","id":4031291,"avatar_url":"https://avatars.githubusercontent.com/u/4031291?v=3","gravatar_id":"","url":"https://api.github.com/users/AmplabJenkins","html_url":"https://github.com/AmplabJenkins","followers_url":"https://api.github.com/users/AmplabJenkins/followers","following_url":"https://api.github.com/users/AmplabJenkins/following{/other_user}","gists_url":"https://api.github.com/users/AmplabJenkins/gists{/gist_id}","starred_url":"https://api.github.com/users/AmplabJenkins/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/AmplabJenkins/subscriptions","organizations_url":"https://api.github.com/users/AmplabJenkins/orgs","repos_url":"https://api.github.com/users/AmplabJenkins/repos","events_url":"https://api.github.com/users/AmplabJenkins/events{/privacy}","received_events_url":"https://api.github.com/users/AmplabJenkins/received_events","type":"User","site_admin":false},"created_at":"2016-11-17T12:02:31Z","updated_at":"2016-11-17T12:02:31Z","body":"Test FAILed.\nRefer to this link for build results (access rights to CI server needed): \nhttps://amplab.cs.berkeley.edu/jenkins//job/SparkPullRequestBuilder/68773/\nTest FAILed."}}
{"actor":{"display_login":"AmplabJenkins"}}