[SPARKR][DOCS] R code doc cleanup #13798
Conversation
felixcheung
changed the title
|
Opened a JIRA since we are removing methods. |
|
Test build #60903 has finished for PR 13798 at commit
|
|
Hmm can we document somewhere why we want to remove this functionality ? Is this because spark context is no longer accessible ? |
|
Right they are really SparkContext methods - I could leave/deprecate them if you'd prefer, or separate that into a different PR? |
felixcheung
changed the title
|
No more jobGroup changes |
|
Yeah lets do that in a separate PR with discussion ? We don't lose much by leaving in a few extra functions that we deprecate / remove later. Thanks for the doc cleanup - I'll take one more look at that now |
R/pkg/R/generics.R
Outdated
| setGeneric("isNull", function(x) { standardGeneric("isNull") }) | ||
|
|
||
| #' @rdname column | ||
| #' @rdname column functions |
There was a problem hiding this comment.
not sure i follow the intent here - do we want these all in the same rd ? Also is there supposed to be an underscore (i.e. column_functions) instead of a space ?
There was a problem hiding this comment.
They were on one page, but "column" is the wrong rd to put them - there's already the class Column and function column. (there's also function columns but that's a different page) - so the intent is to put these in their separate pages as column functions)
it looked like this previously:
This is still buggy - investigating.
|
Test build #60906 has finished for PR 13798 at commit
|
|
Fixed. I double-checked all affected rd. |
| #' \item{"Option 3"} {Return a new SparkDataFrame partitioned by the given column(s), | ||
| #' \item{2.} {Return a new SparkDataFrame that has exactly `numPartitions`.} | ||
| #' \item{3.} {Return a new SparkDataFrame partitioned by the given column(s), | ||
| #' using `spark.sql.shuffle.partitions` as number of partitions.} |
There was a problem hiding this comment.
For the ordered itemize, what about the following?
#' \enumerate{
#' \item Return a new SparkDataFrame partitioned by the given columns into `numPartitions`.
#' \item Return a new SparkDataFrame that has exactly `numPartitions`.
#' \item Return a new SparkDataFrame partitioned by the given column(s),
#' using `spark.sql.shuffle.partitions` as number of partitions.
#' }
There was a problem hiding this comment.
it mentioned "these options" (as in one of these choices) on the line before, so I thought it's nicer to numbered the options.
in other cases we have unnumbered bullets if they are enum values and so on.
|
Thanks for the update. This one looks fine to me now. @dongjoon-hyun Any other comments ? |
|
Test build #60909 has finished for PR 13798 at commit
|
|
Alright I'm merging this to master and branch-2.0 so that it makes it to the RC. We can try and fix minor things going forward Thanks @felixcheung -- This is a much needed clean up. |
## What changes were proposed in this pull request? I ran a full pass from A to Z and fixed the obvious duplications, improper grouping etc. There are still more doc issues to be cleaned up. ## How was this patch tested? manual tests Author: Felix Cheung <[email protected]> Closes #13798 from felixcheung/rdocseealso. (cherry picked from commit 09f4cea) Signed-off-by: Shivaram Venkataraman <[email protected]>
4 participants
What changes were proposed in this pull request?
I ran a full pass from A to Z and fixed the obvious duplications, improper grouping etc.
There are still more doc issues to be cleaned up.
How was this patch tested?
manual tests