Skip to content
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

[R] CRAN incoming checks show NOTE due to internal function which isn't documented #37456

Closed
thisisnic opened this issue Aug 30, 2023 · 0 comments · Fixed by #37457
Closed

[R] CRAN incoming checks show NOTE due to internal function which isn't documented #37456

thisisnic opened this issue Aug 30, 2023 · 0 comments · Fixed by #37457
Assignees
@thisisnic
Labels
Component: R Type: bug
Milestone
14.0.0

Comments

@thisisnic
Copy link
Member

thisisnic commented Aug 30, 2023 •
edited
Loading

Describe the bug, including details regarding any error messages, version, and platform.

From the 13.0.0 release after submission to CRAN:

Flavor: r-devel-linux-x86_64-debian-gcc
Check: Rd \usage sections, Result: NOTE
  Documented arguments not in \usage in documentation object 'register_binding':
    'agg_fun'

While this is on an internal function, let's add a roxygen header with the @rdname tag to register_binding_agg() to stop this triggering a NOTE on CRAN

It appears to be due to this change in R-devel:

‘tools::checkDocFiles()’ and ‘tools::checkRdContents()’ now also check internal Rd files by default, but “specially” (ignoring missing documentation of arguments).

Component(s)

R
@thisisnic thisisnic self-assigned this Aug 30, 2023
@github-actions github-actions bot mentioned this issue Aug 30, 2023
Merged
thisisnic added a commit that referenced this issue Aug 31, 2023
@thisisnic
GH-37456: [R] CRAN incoming checks show NOTE due to internal function…
58c2c37 
… which isn't documented (#37457)

### Rationale for this change

Failed CRAN check due to updates to their checks on R-devel

### What changes are included in this PR?

Add additional roxygen header

### Are these changes tested?

No

### Are there any user-facing changes?

No
* Closes: #37456

Authored-by: Nic Crane <thisisnic@gmail.com>
Signed-off-by: Nic Crane <thisisnic@gmail.com>
@thisisnic thisisnic added this to the 14.0.0 milestone Aug 31, 2023
loicalleyne pushed a commit to loicalleyne/arrow that referenced this issue Nov 13, 2023
@thisisnic @loicalleyne
apacheGH-37456: [R] CRAN incoming checks show NOTE due to internal fu…
3d2caec 
…nction which isn't documented (apache#37457)

### Rationale for this change

Failed CRAN check due to updates to their checks on R-devel

### What changes are included in this PR?

Add additional roxygen header

### Are these changes tested?

No

### Are there any user-facing changes?

No
* Closes: apache#37456

Authored-by: Nic Crane <thisisnic@gmail.com>
Signed-off-by: Nic Crane <thisisnic@gmail.com>
dgreiss pushed a commit to dgreiss/arrow that referenced this issue Feb 19, 2024
@thisisnic @dgreiss
apacheGH-37456: [R] CRAN incoming checks show NOTE due to internal fu…
33e72d0 
…nction which isn't documented (apache#37457)

### Rationale for this change

Failed CRAN check due to updates to their checks on R-devel

### What changes are included in this PR?

Add additional roxygen header

### Are these changes tested?

No

### Are there any user-facing changes?

No
* Closes: apache#37456

Authored-by: Nic Crane <thisisnic@gmail.com>
Signed-off-by: Nic Crane <thisisnic@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@thisisnic thisisnic

Labels
Component: R Type: bug
Projects
None yet
Milestone
14.0.0
1 participant
@thisisnic