You are viewing a plain text version of this content. The canonical link for it is here.

Posted to github@arrow.apache.org by GitBox <gi...@apache.org> on 2022/03/17 10:15:38 UTC

[GitHub] [arrow] jorisvandenbossche edited a comment on pull request #12543: ARROW-15432: [Python] Address CSV docstrings

jorisvandenbossche edited a comment on pull request #12543:
URL: https://github.com/apache/arrow/pull/12543#issuecomment-1070550657


   > I fear this makes the docstring overly long and will make displaying a bit uncomfortable.
   
   Another option would be to move them to the user guide. That of course makes them less accessible from the console or notebook where you check the docstring, but for the online docs that might actually give a nicer experience. 
   
   EDIT: Alenka and I just chatted about this, and maybe a better option is to improve the user guide a bit to have better pointers to the options, and then keep the examples in the option docstrings as is being done now in the PR here.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org