`cran-extrachecks`: clarify rules on exported generic functions
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 85/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Tech stack
- r
- Domain
- documentation
Research direction
Edit r-lib/cran-extrachecks/SKILL.md. Start by reading the rules for exported functions and the CRAN checks for @return and @examples, then clarify the exception for exported S3 generics such as print.class_name when only @export is present and no .Rd is created. Done means the skill clearly explains when those tags are not required.
Written by the indexing model from the issue text.
Description
Have been trying out the CRAN submission skill and it has done great; much better than my earlier attempt to do something similar.
The one issue I've run into is that it flags exported S3 generics, e.g. print.class_name, as needing @return and @examples, even if there is no Roxygen documentation except #' @export.
Seems like it might be good to edit the skill to explain this exception to the CRAN rules (no .Rd is actually created here)
- Dominant language
- R
- Stars
- 517
- Forks
- 53
- Avg merge
- 17m
- Merged PRs (30d)
- 4
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from posit-dev/skills
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 4/5 3-5 days Newbie friendliness 38/100
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
All issues in posit-dev/skills
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
r-lib/pkgdepends#485 · 3 comments ·
-
Difficulty 1/5 Under an hour Newbie friendliness 92/100
-
beginners blocker
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enviPathR OpenBuild Error Build OK Build Warning policies-accepted pre-review precheck-passed
Difficulty 1/5 Under an hour Newbie friendliness 84/100
Bioconductor/BiocContributions#207 · 6 comments ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
datacarpentry/semester-biology#1255 ·