Skip to content

[SPARK-16109][SPARKR][DOC] R more doc fixes#13803

Closed
felixcheung wants to merge 3 commits intoapache:masterfrom
felixcheung:rdocrd
Closed

[SPARK-16109][SPARKR][DOC] R more doc fixes#13803
felixcheung wants to merge 3 commits intoapache:masterfrom
felixcheung:rdocrd

Conversation

@felixcheung
Copy link
Member

What changes were proposed in this pull request?

Found these issues while reviewing for SPARK-16090

How was this patch tested?

roxygen2 doc gen, checked output html

@felixcheung
Copy link
Member Author

@shivaram

@SparkQA
Copy link

SparkQA commented Jun 21, 2016

Test build #60920 has finished for PR 13803 at commit 9ff4e6e.

  • This patch passes all tests.
  • This patch merges cleanly.
  • This patch adds no public classes.

@SparkQA
Copy link

SparkQA commented Jun 21, 2016

Test build #60924 has finished for PR 13803 at commit 1d6e9c5.

  • This patch passes all tests.
  • This patch merges cleanly.
  • This patch adds no public classes.

@shivaram
Copy link
Contributor

cc @mengxr

@shivaram
Copy link
Contributor

@felixcheung Can you change the JIRA in the title to https://issues.apache.org/jira/browse/SPARK-16109 ? I created a sub-task for statfunctions

#' occurrences will have zero as their counts.
#'
#' @rdname statfunctions
#' @rdname crosstab
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we have a @family stat_functions here to point users to other stat functions ?

@felixcheung felixcheung changed the title [SPARKR][DOC] R more doc fixes [SPARK-16109][SPARKR][DOC] R more doc fixes Jun 21, 2016
@shivaram
Copy link
Contributor

Other than the comment about the family link the rest of the changes look good

@felixcheung
Copy link
Member Author

done - @family doesn't need to be one word so added "stat functions"

@shivaram
Copy link
Contributor

Thanks - rebuilt locally and the docs look good. Will merge after Jenkins passes

@SparkQA
Copy link

SparkQA commented Jun 21, 2016

Test build #60942 has finished for PR 13803 at commit 0bc74c3.

  • This patch passes all tests.
  • This patch merges cleanly.
  • This patch adds no public classes.

@shivaram
Copy link
Contributor

LGTM. Merging this

asfgit pushed a commit that referenced this pull request Jun 21, 2016
## What changes were proposed in this pull request?

Found these issues while reviewing for SPARK-16090

## How was this patch tested?

roxygen2 doc gen, checked output html

Author: Felix Cheung <felixcheung_m@hotmail.com>

Closes #13803 from felixcheung/rdocrd.

(cherry picked from commit 5774629)
Signed-off-by: Shivaram Venkataraman <shivaram@cs.berkeley.edu>
@asfgit asfgit closed this in 5774629 Jun 21, 2016
@felixcheung
Copy link
Member Author

Great! Thanks! Hopefully now docs are in much better shape.

@shivaram
Copy link
Contributor

Yeah - thanks for all the work in cleaning this up. One thing that i was wondering is we could add some style guide checks or contribution guide rules on how to maintain documentation. We can discuss this in SPARK-16090 or in a new JIRA

@felixcheung
Copy link
Member Author

I have been thinking about the same thing - problem is people generally do not read contribution guide :) if there is a way to get automatic style check it would be good.

@shivaram
Copy link
Contributor

shivaram commented Jun 21, 2016

Irrespective of people reading the guide, it'll at least be useful to point out what is the expected documentation layout in a code review etc. But yeah automatic style checks would be really cool.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

Comments