Github user felixcheung commented on a diff in the pull request:
https://github.com/apache/spark/pull/23025#discussion_r236970732
--- Diff: R/pkg/R/DataFrame.R ---
@@ -767,6 +767,14 @@ setMethod("repartition",
#' using \code{spark.sql.shuffle.partitions} as
number of partitions.}
#'}
#'
+#' At least one partition-by expression must be specified.
--- End diff --
761 is significant also, but correct.
essentially:
1. first line of the blob is the title (L760)
2. second text after "empty line" is the description (L762)
3. third after another "empty line" is the "detail note" which is stashed
all the way to the bottom of the doc page
so generally you want "important" part of the description on top and not in
the "detail" section because it is easily missed.
this is the most common pattern in this code base. there's another, where
multiple function is doc together as a group, eg. collection sql function (in
functions.R). other finer control is possible as well but not used today in
this code base.
similarly L829 is good, L831 is a bit fuzzy - I'd personally prefer without
L831 to keep the whole text in the description section of the doc.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org
