[ 
https://issues.apache.org/jira/browse/ARROW-13886?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Nic Crane updated ARROW-13886:
------------------------------
    Description: 
Two main things we could update here:
 # The general description of what the decimal type is and is for and/or a link 
to the C++ docs - in the details section, add some explanation of what an Arrow 
{{decimal()}} type is and why it is automatically mapped to an R {{double}} type
 # Documentation of the params precision and scale.  We could add a bit more 
information to explain what that actually means to the user, as it's not 
immediately obvious.

 

  was:
Currently in the docs for {{decimal()}}, the documentation of the arguments 
reads:

{{precision For decimal(), precision}}

{{scale For decimal(), scale}}

We should add a bit more information to explain what that actually means to the 
user, as it's not immediately obvious.

 


> [R] Expand documentation for decimal()
> --------------------------------------
>
>                 Key: ARROW-13886
>                 URL: https://issues.apache.org/jira/browse/ARROW-13886
>             Project: Apache Arrow
>          Issue Type: Improvement
>          Components: R
>            Reporter: Nic Crane
>            Priority: Minor
>              Labels: good-first-issue
>
> Two main things we could update here:
>  # The general description of what the decimal type is and is for and/or a 
> link to the C++ docs - in the details section, add some explanation of what 
> an Arrow {{decimal()}} type is and why it is automatically mapped to an R 
> {{double}} type
>  # Documentation of the params precision and scale.  We could add a bit more 
> information to explain what that actually means to the user, as it's not 
> immediately obvious.
>  



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

Reply via email to