Nic Crane created ARROW-13397:
---------------------------------

             Summary: [R] Update arrow.Rmd vignette
                 Key: ARROW-13397
                 URL: https://issues.apache.org/jira/browse/ARROW-13397
             Project: Apache Arrow
          Issue Type: Improvement
          Components: Documentation, R
            Reporter: Nic Crane


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.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

Reply via email to