Example in `?ggproto` counterproducive
Open
Nobody has claimed this yet.
documentation
- Dominant language
- R
- Stars
- 7k
- Forks
- 2.1k
- Avg merge
- 59m
- Merged PRs (30d)
- 2
Description
The example in ?ggproto gives an example of a stateful class (.e.g Adder$x) is a stateful field.
It advertises a property of ggproto classes that should be used sparingly and ideally not at all if you're developing extensions.
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 locating the documentation source for ?ggproto and inspect the Adder$x stateful-field example described in the issue. Update the example so it does not encourage stateful fields in extensions, while preserving useful guidance about ggproto classes; verify the rendered help remains clear.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100