Details
-
Improvement
-
Status: Closed
-
Major
-
Resolution: Won't Fix
-
None
-
None
-
None
Description
Proposed updates:
- Define what is meant by "reader" and "writer" before using those terms
- Add some more code examples to the vignette to break up the text
- Remove backticks from package names to make it easier to skim (see dplyr vignette)
- Move "Object Hierarchy" and "Internals" sections" into their own vignette and link to it
- Break up the "Class structure and package conventions" section so that the code examples are in chunks rather than inline, and it's more skimmable. Perhaps add subsections to help with this aim too.