[
https://issues.apache.org/jira/browse/ARROW-15430?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Alenka Frim updated ARROW-15430:
--------------------------------
Description:
Ensure docstrings for Filesystem Interface have an {{Examples}} section:
*
[https://arrow.apache.org/docs/python/generated/pyarrow.fs.FileInfo.html#pyarrow.fs.FileInfo]
*
[https://arrow.apache.org/docs/python/generated/pyarrow.fs.FileSelector.html#pyarrow.fs.FileSelector]
*
[https://arrow.apache.org/docs/python/generated/pyarrow.fs.FileSystem.html#pyarrow.fs.FileSystem]
was:
Ensure all docstrings in https://arrow.apache.org/docs/python/api/files.html
and https://arrow.apache.org/docs/python/api/filesystems.html have an
{{Examples}} section
Most important
{code}
/docs/python/generated/pyarrow.fs.S3FileSystem.html
{code}
> [Python] Address docstrings in Filesystems (Interface)
> ------------------------------------------------------
>
> Key: ARROW-15430
> URL: https://issues.apache.org/jira/browse/ARROW-15430
> Project: Apache Arrow
> Issue Type: Sub-task
> Components: Python
> Reporter: Alessandro Molina
> Assignee: Alenka Frim
> Priority: Major
> Fix For: 8.0.0
>
>
> Ensure docstrings for Filesystem Interface have an {{Examples}} section:
> *
> [https://arrow.apache.org/docs/python/generated/pyarrow.fs.FileInfo.html#pyarrow.fs.FileInfo]
> *
> [https://arrow.apache.org/docs/python/generated/pyarrow.fs.FileSelector.html#pyarrow.fs.FileSelector]
> *
> [https://arrow.apache.org/docs/python/generated/pyarrow.fs.FileSystem.html#pyarrow.fs.FileSystem]
>
>
--
This message was sent by Atlassian Jira
(v8.20.1#820001)
