Skip to content

[DOCS][SPARKR] Use verbose names for family annotations in functions.R #17976

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 2 commits into from
Closed

[DOCS][SPARKR] Use verbose names for family annotations in functions.R #17976

wants to merge 2 commits into from

Conversation

@zero323
Copy link
Member

@zero323 zero323 commented May 14, 2017

What changes were proposed in this pull request?

  • Change current short annotations (same as Scala @group) to verbose names (same as Scala @groupname).

    Before:

    image

    After:
    image

  • Add missing @family annotations.

How was this patch tested?

check-cran.R (skipping tests), manual inspection.

@zero323
Copy link
Member Author

zero323 commented May 14, 2017

Note: if multiple functions use the same @rdname, there is only @family annotation to avoid duplicated See also section.

@SparkQA
Copy link

SparkQA commented May 14, 2017

Test build #76906 has finished for PR 17976 at commit a006f32.

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

felixcheung
felixcheung approved these changes May 14, 2017
View reviewed changes
Copy link
Member

@felixcheung felixcheung left a comment

Choose a reason for hiding this comment

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

LGTM

@felixcheung
Copy link
Member

felixcheung commented May 14, 2017

merged to master. thanks!

@asfgit asfgit closed this in aa3df15 May 14, 2017
@zero323
Copy link
Member Author

zero323 commented May 14, 2017

Thanks Felix!

robert3005 pushed a commit to palantir/spark that referenced this pull request May 19, 2017
@zero323
[DOCS][SPARKR] Use verbose names for family annotations in functions.R
f81616a 
## What changes were proposed in this pull request?

- Change current short annotations (same as Scala `group`) to verbose names (same as Scala `groupname`).

    Before:

    ![image](https://cloud.githubusercontent.com/assets/1554276/26033909/9a98b596-38b4-11e7-961e-15fd9ea7440d.png)

    After:
    ![image](https://cloud.githubusercontent.com/assets/1554276/26033903/727a9944-38b4-11e7-8873-b09c553f4ec3.png)

- Add missing `family` annotations.

## How was this patch tested?

`check-cran.R` (skipping tests), manual inspection.

Author: zero323 <[email protected]>

Closes apache#17976 from zero323/SPARKR-FUNCTIONS-DOCSTRINGS.
liyichao pushed a commit to liyichao/spark that referenced this pull request May 24, 2017
@zero323 @liyichao
[DOCS][SPARKR] Use verbose names for family annotations in functions.R
ec5741c 
## What changes were proposed in this pull request?

- Change current short annotations (same as Scala `group`) to verbose names (same as Scala `groupname`).

    Before:

    ![image](https://cloud.githubusercontent.com/assets/1554276/26033909/9a98b596-38b4-11e7-961e-15fd9ea7440d.png)

    After:
    ![image](https://cloud.githubusercontent.com/assets/1554276/26033903/727a9944-38b4-11e7-8873-b09c553f4ec3.png)

- Add missing `family` annotations.

## How was this patch tested?

`check-cran.R` (skipping tests), manual inspection.

Author: zero323 <[email protected]>

Closes apache#17976 from zero323/SPARKR-FUNCTIONS-DOCSTRINGS.
@zero323 zero323 deleted the SPARKR-FUNCTIONS-DOCSTRINGS branch February 2, 2020 17:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@felixcheung felixcheung felixcheung approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@zero323 @SparkQA @felixcheung