[GitHub] spark pull request #14522: [Spark-16508][SparkR] Split docs for arrange and ...

[asfgit]

Github user asfgit closed the pull request at:

https://github.com/apache/spark/pull/14522


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

-
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org

[GitHub] spark pull request #14522: [Spark-16508][SparkR] Split docs for arrange and ...

[felixcheung]

Github user felixcheung commented on a diff in the pull request:

https://github.com/apache/spark/pull/14522#discussion_r74524646
  
--- Diff: R/pkg/R/DataFrame.R ---
@@ -2121,7 +2121,7 @@ setMethod("arrange",
   })
 
 #' @rdname arrange
-#' @name orderBy
--- End diff --

It's not required to be specified but when it is missing it is inferred 
from the function name, and it's used by roxygen2.
Do you have the generated HTML? it might help to isolate what's going on.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

-
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org

[GitHub] spark pull request #14522: [Spark-16508][SparkR] Split docs for arrange and ...

[junyangq]

Github user junyangq commented on a diff in the pull request:

https://github.com/apache/spark/pull/14522#discussion_r74528178
  
--- Diff: R/pkg/R/DataFrame.R ---
@@ -2121,7 +2121,7 @@ setMethod("arrange",
   })
 
 #' @rdname arrange
-#' @name orderBy
--- End diff --

The top of the arrange.Rd looks like

\docType{methods}
\name{arrange}
\alias{arrange}
\alias{arrange,SparkDataFrame,Column-method}
\alias{arrange,SparkDataFrame,character-method}
\alias{orderBy,SparkDataFrame,characterOrColumn-method}

orderBy.Rd looks like

\docType{methods}
\name{orderBy}
\alias{orderBy}
\alias{orderBy,WindowSpec,Column-method}
\alias{orderBy,WindowSpec,character-method}
\title{Ordering Columns in a WindowSpec}


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

-
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org

[GitHub] spark pull request #14522: [Spark-16508][SparkR] Split docs for arrange and ...

[junyangq]

Github user junyangq commented on a diff in the pull request:

https://github.com/apache/spark/pull/14522#discussion_r74528040
  
--- Diff: R/pkg/R/DataFrame.R ---
@@ -2121,7 +2121,7 @@ setMethod("arrange",
   })
 
 #' @rdname arrange
-#' @name orderBy
--- End diff --

Hmm... The generated HTMLs look almost the same (except for some 
punctuations) as the ones above. 


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

-
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org

[GitHub] spark pull request #14522: [Spark-16508][SparkR] Split docs for arrange and ...

[junyangq]

Github user junyangq commented on a diff in the pull request:

https://github.com/apache/spark/pull/14522#discussion_r74536151
  
--- Diff: R/pkg/R/DataFrame.R ---
@@ -2121,7 +2121,7 @@ setMethod("arrange",
   })
 
 #' @rdname arrange
-#' @name orderBy
--- End diff --

Oh I see what you meant. Well if @name is added different from @rdname, 
then \alias{orderBy} appears both in orderBy.Rd and arrange.Rd. I guess that's 
the root of the complaint.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

-
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org

[GitHub] spark pull request #14522: [Spark-16508][SparkR] Split docs for arrange and ...

[felixcheung]

Github user felixcheung commented on a diff in the pull request:

https://github.com/apache/spark/pull/14522#discussion_r74529416
  
--- Diff: R/pkg/R/DataFrame.R ---
@@ -2121,7 +2121,7 @@ setMethod("arrange",
   })
 
 #' @rdname arrange
-#' @name orderBy
--- End diff --

hmm, so you are saying having a @name is ok?


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

-
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org

[GitHub] spark pull request #14522: [Spark-16508][SparkR] Split docs for arrange and ...

[junyangq]

Github user junyangq commented on a diff in the pull request:

https://github.com/apache/spark/pull/14522#discussion_r74455714
  
--- Diff: R/pkg/R/DataFrame.R ---
@@ -2121,7 +2121,7 @@ setMethod("arrange",
   })
 
 #' @rdname arrange
-#' @name orderBy
--- End diff --

I didn't see that as a requirement from the manual. Do we only need a 
single \name field for an Rd? I guess the duplicated alias issue is caused by 
multiple documents pointed by the same method if we use different @rdname and 
@name?


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

-
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org

[GitHub] spark pull request #14522: [Spark-16508][SparkR] Split docs for arrange and ...

[felixcheung]

Github user felixcheung commented on a diff in the pull request:

https://github.com/apache/spark/pull/14522#discussion_r74345269
  
--- Diff: R/pkg/R/DataFrame.R ---
@@ -2121,7 +2121,7 @@ setMethod("arrange",
   })
 
 #' @rdname arrange
-#' @name orderBy
--- End diff --

@name is actually an required field for roxygen - so it will just going to 
infer that from the function signature right after this comment block, if it is 
not specified.
I'm surprised about the duplicate alias though - do you mean @aliases or 
something else?


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

-
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org

[GitHub] spark pull request #14522: [Spark-16508][SparkR] Split docs for arrange and ...

[junyangq]

Github user junyangq commented on a diff in the pull request:

https://github.com/apache/spark/pull/14522#discussion_r74289056
  
--- Diff: R/pkg/R/DataFrame.R ---
@@ -2121,7 +2121,7 @@ setMethod("arrange",
   })
 
 #' @rdname arrange
-#' @name orderBy
--- End diff --

I deleted this line eventually - otherwise it would have duplicated alias 
for orderBy.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

-
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org

[GitHub] spark pull request #14522: [Spark-16508][SparkR] Split docs for arrange and ...

[felixcheung]

Github user felixcheung commented on a diff in the pull request:

https://github.com/apache/spark/pull/14522#discussion_r73994436
  
--- Diff: R/pkg/R/generics.R ---
@@ -771,6 +771,10 @@ setGeneric("over", function(x, window) { 
standardGeneric("over") })
 
 ## WindowSpec Methods ##
 
+#' @rdname orderBy
+#' @export
--- End diff --

I think that's ok. Doc for the generics isn't super useful anyway.




---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

-
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org

[GitHub] spark pull request #14522: [Spark-16508][SparkR] Split docs for arrange and ...

[junyangq]

Github user junyangq commented on a diff in the pull request:

https://github.com/apache/spark/pull/14522#discussion_r73983727
  
--- Diff: R/pkg/R/generics.R ---
@@ -771,6 +771,10 @@ setGeneric("over", function(x, window) { 
standardGeneric("over") })
 
 ## WindowSpec Methods ##
 
+#' @rdname orderBy
+#' @export
--- End diff --

Perhaps to orderBy? When applied to SparkDataFrame, it simply calls the 
arrange function.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

-
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org

[GitHub] spark pull request #14522: [Spark-16508][SparkR] Split docs for arrange and ...

[junyangq]

Github user junyangq commented on a diff in the pull request:

https://github.com/apache/spark/pull/14522#discussion_r73983612
  
--- Diff: R/pkg/R/generics.R ---
@@ -771,6 +771,10 @@ setGeneric("over", function(x, window) { 
standardGeneric("over") })
 
 ## WindowSpec Methods ##
 
+#' @rdname orderBy
+#' @export
--- End diff --

I checked the generated docs, and it showed in both docs, but I do agree 
that it is not necessary considering the purpose of `setGeneric`. Then we have 
to decide where to put it...


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

-
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org

[GitHub] spark pull request #14522: [Spark-16508][SparkR] Split docs for arrange and ...

[felixcheung]

Github user felixcheung commented on a diff in the pull request:

https://github.com/apache/spark/pull/14522#discussion_r73981600
  
--- Diff: R/pkg/R/generics.R ---
@@ -771,6 +771,10 @@ setGeneric("over", function(x, window) { 
standardGeneric("over") })
 
 ## WindowSpec Methods ##
 
+#' @rdname orderBy
+#' @export
--- End diff --

hmm, that's interesting. I'm not sure if this is necessary, or if this 
works. I think the purpose of setGeneric would only need this once. By putting 
a @rdname tag it will show up on the Rd file, but I don't think we need to put 
it twice, once in different Rd?



---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

-
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org

[GitHub] spark pull request #14522: [Spark-16508][SparkR] Split docs for arrange and ...

[junyangq]

Github user junyangq commented on a diff in the pull request:

https://github.com/apache/spark/pull/14522#discussion_r73907661
  
--- Diff: R/pkg/R/generics.R ---
@@ -551,7 +551,7 @@ setGeneric("merge")
 #' @export
 setGeneric("mutate", function(.data, ...) {standardGeneric("mutate") })
 
-#' @rdname arrange
+#' @rdname orderBy
--- End diff --

Yes, I guess then we should put them in both docs, orderBy and arrange?


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

-
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org

[GitHub] spark pull request #14522: [Spark-16508][SparkR] Split docs for arrange and ...

[junyangq]

Github user junyangq commented on a diff in the pull request:

https://github.com/apache/spark/pull/14522#discussion_r73904520
  
--- Diff: R/pkg/R/WindowSpec.R ---
@@ -82,16 +82,18 @@ setMethod("partitionBy",
 }
   })
 
-#' orderBy
+#' Ordering Columns in a WindowSpec
 #'
 #' Defines the ordering columns in a WindowSpec.
-#'
 #' @param x a WindowSpec
-#' @return a WindowSpec
-#' @rdname arrange
+#' @param col a character or Column object indicating an ordering column
+#' @param ... additional sorting fields
+#' @return A WindowSpec
--- End diff --

It seems that the docs I saw from `base` package lower case the arguments 
and capitalize the first letter of return value part. 


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

-
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org

[GitHub] spark pull request #14522: [Spark-16508][SparkR] Split docs for arrange and ...

[junyangq]

Github user junyangq commented on a diff in the pull request:

https://github.com/apache/spark/pull/14522#discussion_r73903804
  
--- Diff: R/pkg/R/DataFrame.R ---
@@ -2121,7 +2121,7 @@ setMethod("arrange",
   })
 
 #' @rdname arrange
-#' @name orderBy
--- End diff --

Done. Thanks!


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

-
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org

[GitHub] spark pull request #14522: [Spark-16508][SparkR] Split docs for arrange and ...

[felixcheung]

Github user felixcheung commented on a diff in the pull request:

https://github.com/apache/spark/pull/14522#discussion_r73824558
  
--- Diff: R/pkg/R/generics.R ---
@@ -551,7 +551,7 @@ setGeneric("merge")
 #' @export
 setGeneric("mutate", function(.data, ...) {standardGeneric("mutate") })
 
-#' @rdname arrange
+#' @rdname orderBy
--- End diff --

hmm, same here, orderBy for DataFrame should go to rdname arrange, right?


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

-
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org

[GitHub] spark pull request #14522: [Spark-16508][SparkR] Split docs for arrange and ...

[felixcheung]

Github user felixcheung commented on a diff in the pull request:

https://github.com/apache/spark/pull/14522#discussion_r73824520
  
--- Diff: R/pkg/R/WindowSpec.R ---
@@ -82,16 +82,18 @@ setMethod("partitionBy",
 }
   })
 
-#' orderBy
+#' Ordering Columns in a WindowSpec
 #'
 #' Defines the ordering columns in a WindowSpec.
-#'
 #' @param x a WindowSpec
-#' @return a WindowSpec
-#' @rdname arrange
+#' @param col a character or Column object indicating an ordering column
+#' @param ... additional sorting fields
+#' @return A WindowSpec
--- End diff --

lower case `a` for consistency?


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

-
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org

[GitHub] spark pull request #14522: [Spark-16508][SparkR] Split docs for arrange and ...

[felixcheung]

Github user felixcheung commented on a diff in the pull request:

https://github.com/apache/spark/pull/14522#discussion_r73824487
  
--- Diff: R/pkg/R/DataFrame.R ---
@@ -2121,7 +2121,7 @@ setMethod("arrange",
   })
 
 #' @rdname arrange
-#' @name orderBy
--- End diff --

this should match the name of the actual method, `orderBy`


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

-
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org

[GitHub] spark pull request #14522: [Spark-16508][SparkR] Split docs for arrange and ...

[felixcheung]

Github user felixcheung commented on a diff in the pull request:

https://github.com/apache/spark/pull/14522#discussion_r73824170
  
--- Diff: R/pkg/R/WindowSpec.R ---
@@ -82,10 +82,18 @@ setMethod("partitionBy",
 }
   })
 
-#' @rdname orderBy
+#' Ordering Columns in a WindowSpec
+#'
+#' Defines the ordering columns in a WindowSpec.
+#' @param x a WindowSpec
+#' @param col a character or Column object indicating an ordering column
+#' @param ... additional sorting fields
+#' @return A WindowSpec
--- End diff --

lower case 'a' to be consistent?


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

-
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org

[GitHub] spark pull request #14522: [Spark-16508][SparkR] Split docs for arrange and ...

[felixcheung]

Github user felixcheung commented on a diff in the pull request:

https://github.com/apache/spark/pull/14522#discussion_r73797672
  
--- Diff: R/pkg/R/generics.R ---
@@ -551,7 +551,15 @@ setGeneric("merge")
 #' @export
 setGeneric("mutate", function(.data, ...) {standardGeneric("mutate") })
 
-#' @rdname arrange
+#' Ordering Columns in a WindowSpec
--- End diff --

please put this block in windowsspec.R


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

-
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org

[GitHub] spark pull request #14522: [Spark-16508][SparkR] Split docs for arrange and ...

[junyangq]

GitHub user junyangq opened a pull request:

https://github.com/apache/spark/pull/14522

[Spark-16508][SparkR] Split docs for arrange and orderBy methods

## What changes were proposed in this pull request?

This PR splits arrange and orderBy methods according to their functionality 
(the former for sorting sparkDataFrame and the latter for windowSpec). 

## How was this patch tested?

![screen shot 2016-08-06 at 6 39 19 
pm](https://cloud.githubusercontent.com/assets/15318264/17459969/51eade28-5c05-11e6-8ca1-8d8a8e344bab.png)
![screen shot 2016-08-06 at 6 39 29 
pm](https://cloud.githubusercontent.com/assets/15318264/17459966/51e3c246-5c05-11e6-8d35-3e905ca48676.png)
![screen shot 2016-08-06 at 6 40 02 
pm](https://cloud.githubusercontent.com/assets/15318264/17459967/51e650ec-5c05-11e6-8698-0f037f5199ff.png)


You can merge this pull request into a Git repository by running:

$ git pull https://github.com/junyangq/spark SPARK-16508-0

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/spark/pull/14522.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 #14522


commit 0876b7588cee1b2d39ffe8869e6b8320d8e27d1e
Author: Junyang Qian 
Date:   2016-08-05T22:41:39Z

Separate docs for arrange and orderBy methods according to their 
functionality




---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

-
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org