[GitHub] spark issue #22393: [MINOR][DOCS] Axe deprecated doc refs
Github user MichaelChirico commented on the issue: https://github.com/apache/spark/pull/22393 @felixcheung done https://user-images.githubusercontent.com/7606389/45593911-617ad000-b9c3-11e8-892a-4690396b66a1.png;> https://user-images.githubusercontent.com/7606389/45593914-73f50980-b9c3-11e8-93be-842012cbdafe.png;> --- - To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org For additional commands, e-mail: reviews-h...@spark.apache.org
[GitHub] spark issue #22393: [MINOR][DOCS] Axe deprecated doc refs
Github user MichaelChirico commented on the issue: https://github.com/apache/spark/pull/22393 @felixcheung is that to me? --- - To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org For additional commands, e-mail: reviews-h...@spark.apache.org
[GitHub] spark issue #22393: [MINOR][DOCS] Axe deprecated doc refs
Github user MichaelChirico commented on the issue: https://github.com/apache/spark/pull/22393 @srowen thanks; done --- - To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org For additional commands, e-mail: reviews-h...@spark.apache.org
[GitHub] spark issue #22370: don't link to deprecated function
Github user MichaelChirico commented on the issue: https://github.com/apache/spark/pull/22370 @felixcheung thanks for the feedback, yes, I axed `registerTempTable` from the `SparkDataFrame `@family`. Sorry I botched an attempt to try and rename the branch of this PR (apparently not possible to overwrite this PR with a new branch name); PR re-filed as #22393 --- - To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org For additional commands, e-mail: reviews-h...@spark.apache.org
[GitHub] spark pull request #22393: Axe deprecated doc refs
GitHub user MichaelChirico opened a pull request: https://github.com/apache/spark/pull/22393 Axe deprecated doc refs Continuation of #22370. Summary of discussion there: There is some inconsistency in the R manual w.r.t. supercedent functions linking back to deprecated functions. - `createOrReplaceTempView` and `createTable` both link back to functions which are deprecated (`registerTempTable` and `createExternalTable`, respectively) - `sparkR.session` and `dropTempView` do _not_ link back to deprecated functions This PR takes the view that it is preferable _not_ to link back to deprecated functions, and removes these references from `?createOrReplaceTempView` and `?createTable`. As `registerTempTable` was included in the `SparkDataFrame functions` `@family` of functions, other documentation pages which included a link to `?registerTempTable` will similarly be altered. You can merge this pull request into a Git repository by running: $ git pull https://github.com/MichaelChirico/spark axe_deprecated_doc_refs Alternatively you can review and apply these changes as the patch at: https://github.com/apache/spark/pull/22393.patch To close this pull request, make a commit to your master/trunk branch with (at least) the following in the commit message: This closes #22393 commit e8b0d6333a1c09787e1c37a6f91eb895dee8fa72 Author: Michael Chirico Date: 2018-09-09T05:12:27Z don't link to deprecated function Seems misleading to (without qualification) link to a deprecated function commit 41d6e26de5bb5b546710db51ce278bdd6182434a Author: Michael Chirico Date: 2018-09-11T10:22:45Z remove deprecated registerTempTable from SparkDataFrame functions family --- - To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org For additional commands, e-mail: reviews-h...@spark.apache.org
[GitHub] spark pull request #22370: don't link to deprecated function
Github user MichaelChirico closed the pull request at: https://github.com/apache/spark/pull/22370 --- - To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org For additional commands, e-mail: reviews-h...@spark.apache.org
[GitHub] spark pull request #22370: don't link to deprecated function
Github user MichaelChirico commented on a diff in the pull request:
https://github.com/apache/spark/pull/22370#discussion_r216222159
--- Diff: R/pkg/R/catalog.R ---
@@ -69,7 +69,6 @@ createExternalTable <- function(x, ...) {
#' @param ... additional named parameters as options for the data source.
#' @return A SparkDataFrame.
#' @rdname createTable
-#' @seealso \link{createExternalTable}
--- End diff --
Shall I amend the PR to fix the `registerTempTable` page as well?
---
-
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org
[GitHub] spark pull request #22370: don't link to deprecated function
Github user MichaelChirico commented on a diff in the pull request:
https://github.com/apache/spark/pull/22370#discussion_r216222094
--- Diff: R/pkg/R/catalog.R ---
@@ -69,7 +69,6 @@ createExternalTable <- function(x, ...) {
#' @param ... additional named parameters as options for the data source.
#' @return A SparkDataFrame.
#' @rdname createTable
-#' @seealso \link{createExternalTable}
--- End diff --
I don't see it here (nothing pointing to
`sparkR.init`/`sparkRHive.init`/`sparkRSQL.init`):
https://spark.apache.org/docs/latest/api/R/sparkR.session.html
or here (nothing pointing to `dropTempTable`):
https://spark.apache.org/docs/latest/api/R/dropTempView.html
But I do see it here (points to `registerTempTable`):
https://spark.apache.org/docs/latest/api/R/createOrReplaceTempView.html
---
-
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org
[GitHub] spark issue #22370: don't link to deprecated function
Github user MichaelChirico commented on the issue: https://github.com/apache/spark/pull/22370 @felixcheung I disagree... what's the point of deprecation if it's going to keep being considered as a co-equal function in the eyes of documentation? If the function is being deprecated, it should be "soft-blacklisted" -- documentation still available (but clearly marked) for users of "legacy" code where its usage still survives, but I don't see any argument for even letting new users find out a deprecated function exists. --- - To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org For additional commands, e-mail: reviews-h...@spark.apache.org
[GitHub] spark pull request #22370: don't link to deprecated function
Github user MichaelChirico commented on a diff in the pull request:
https://github.com/apache/spark/pull/22370#discussion_r216220254
--- Diff: R/pkg/R/catalog.R ---
@@ -69,7 +69,6 @@ createExternalTable <- function(x, ...) {
#' @param ... additional named parameters as options for the data source.
#' @return A SparkDataFrame.
#' @rdname createTable
-#' @seealso \link{createExternalTable}
--- End diff --
Agree...
---
-
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org
[GitHub] spark pull request #22370: don't link to deprecated function
GitHub user MichaelChirico opened a pull request: https://github.com/apache/spark/pull/22370 don't link to deprecated function Seems misleading to (without qualification) link to a deprecated function ## What changes were proposed in this pull request? (Please fill in changes proposed in this fix) ## How was this patch tested? (Please explain how this patch was tested. E.g. unit tests, integration tests, manual tests) (If this patch involves UI changes, please attach a screenshot; otherwise, remove this) Please review http://spark.apache.org/contributing.html before opening a pull request. You can merge this pull request into a Git repository by running: $ git pull https://github.com/MichaelChirico/spark patch-1 Alternatively you can review and apply these changes as the patch at: https://github.com/apache/spark/pull/22370.patch To close this pull request, make a commit to your master/trunk branch with (at least) the following in the commit message: This closes #22370 commit e8b0d6333a1c09787e1c37a6f91eb895dee8fa72 Author: Michael Chirico Date: 2018-09-09T05:12:27Z don't link to deprecated function Seems misleading to (without qualification) link to a deprecated function --- - To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org For additional commands, e-mail: reviews-h...@spark.apache.org
[GitHub] spark pull request #22278: emphasize deprecation [documentation tweak]
Github user MichaelChirico closed the pull request at: https://github.com/apache/spark/pull/22278 --- - To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org For additional commands, e-mail: reviews-h...@spark.apache.org
[GitHub] spark issue #22278: emphasize deprecation [documentation tweak]
Github user MichaelChirico commented on the issue: https://github.com/apache/spark/pull/22278 @HyukjinKwon this is about usability/user-friendliness. As mentioned, despite being a seasoned R user & increasingly familiar with `SparkR` documentation, I spent several minutes googling about before realizing the existing "marking". Happy to try and help file this patch somewhere else if you see fit; just filed here because it's a very easy fix & could be done in-browser without cloning locally/etc --- - To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org For additional commands, e-mail: reviews-h...@spark.apache.org
[GitHub] spark pull request #22278: emphasize deprecation
GitHub user MichaelChirico opened a pull request: https://github.com/apache/spark/pull/22278 emphasize deprecation Was poking around documentation for `formals` of this method as I'd seen it recommended and completely missed the `Deprecated` tag; even after seeing elsewhere it's deprecated, I stared at the documentation for far too long before noticing the existing tag. So, adding this to emphasize further ## What changes were proposed in this pull request? (Please fill in changes proposed in this fix) ## How was this patch tested? (Please explain how this patch was tested. E.g. unit tests, integration tests, manual tests) (If this patch involves UI changes, please attach a screenshot; otherwise, remove this) Please review http://spark.apache.org/contributing.html before opening a pull request. You can merge this pull request into a Git repository by running: $ git pull https://github.com/MichaelChirico/spark patch-1 Alternatively you can review and apply these changes as the patch at: https://github.com/apache/spark/pull/22278.patch To close this pull request, make a commit to your master/trunk branch with (at least) the following in the commit message: This closes #22278 commit b196cbdd7e9a3a54354ad341781552b66f6d6b11 Author: Michael Chirico Date: 2018-08-30T04:06:50Z emphasize deprecation Was poking around documentation for `formals` of this method as I'd seen it recommended and completely missed the `Deprecated` tag; even after seeing elsewhere it's deprecated, I stared at the documentation for far too long before noticing the existing tag. So, adding this to emphasize further --- - To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org For additional commands, e-mail: reviews-h...@spark.apache.org
