Updating documentation of functions generated by `make_constructor()`
Open
Nobody has claimed this yet.
documentation
internals :mag_right:
- Dominant language
- R
- Stars
- 7k
- Forks
- 2.1k
- Avg merge
- 59m
- Merged PRs (30d)
- 2
Description
An issue I ran into during revdepchecks is that ggplot2 can update arguments. Functions in extensions using make_constructor() automatically include those arguments. But the docs don't automatically regenerate on CRAN, which creates warnings about documentation mismatches. We should figure out if we can prevent this problem from happening again.
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.
Research direction
Start by tracing how functions generated by make_constructor() are documented and how revdepchecks expose mismatches on CRAN. Done means establishing a repeatable way to prevent documentation mismatches when ggplot2 updates arguments.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100