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

Add new pkgcheck for undocumented return values #378

Merged
merged 4 commits into from
Aug 23, 2022
Merged

Add new pkgcheck for undocumented return values #378

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5b267ca
Add new pkgcheck for undocumented return values
mpadge Aug 23, 2022
bb50bf4
Update content/blog/2022-08-26-ropensci-news-digest-august-2022/index…
mpadge Aug 23, 2022
30b3311
replace devtools::check -> R CMD check; thanks @maelle
mpadge Aug 23, 2022
751974b
Merge branch 'news-08-22' of https://github.com/mpadge/roweb3 into ne…
mpadge Aug 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion content/blog/2022-08-26-ropensci-news-digest-august-2022/index.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ date: '2022-08-26'
slug: ropensci-news-digest-august-2022
tags:
- newsletter
description: Co-working sessions resume; New package and package news
description: Co-working sessions resume; New package and package news; New 'pkgcheck' check
params:
last_newsletter: '2022-07-22'
---
Expand Down Expand Up @@ -62,6 +62,13 @@ Consult our [Events](/events) page to find your local time and how to join.

Find out about more [events](/events).

### New pkgcheck check for undocumented return values

Our [pkgcheck checks](https://docs.ropensci.org/pkgcheck) now include an additional check that all functions have documented return values.
This check is [run on all new CRAN submissions](https://github.com/DavisVaughan/extrachecks), yet is not currently implemented on any other standard check systems (including devtools::check and goodpractice).
Checking your packages with pkgcheck will now catch any functions which do not document return values, like in [the report on this recent submission](https://github.com/ropensci/software-review/issues/554#issuecomment-1224053977).
All current checks are also listed in [a new vignette](https://docs.ropensci.org/pkgcheck/articles/list-checks.html).

## Software :package:

### New packages
Expand Down