ARROW-7430: [Python] Add more docstrings to dataset bindings #6059
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| @@ -134,6 +135,31 @@ cdef class DefaultPartitionScheme(PartitionScheme): | |||
|
|
|||
|
|
|||
| cdef class SchemaPartitionScheme(PartitionScheme): | |||
| """ | |||
| A PartitionScheme based on a specified Schema. | |||
There was a problem hiding this comment.
There is still discussion to remove those classes, but already wrote those docstrings last week, so including here any way.
There was a problem hiding this comment.
Either way, we can reuse these docstring because the schemes must be explained.
pitrou
reviewed
Dec 18, 2019
python/pyarrow/_dataset.pyx
Outdated
| @@ -270,19 +331,48 @@ cdef class DataSourceDiscovery: | |||
| return schemas | |||
|
|
|||
| def inspect(self): | |||
| """ | |||
| Insects all data fragments and returns a common Schema. | |||
python/pyarrow/_dataset.pyx
Outdated
| cdef CResult[shared_ptr[CDataSource]] result | ||
| with nogil: | ||
| result = self.discovery.Finish() | ||
| return DataSource.wrap(GetResultValue(result)) | ||
|
|
||
|
|
||
| cdef class FileSystemDataSourceDiscovery(DataSourceDiscovery): | ||
| """ | ||
| Creates a DataSource from a list of paths with schema inspection. |
pitrou
reviewed
Dec 18, 2019
pitrou
force-pushed
the
ARROW-7430-dataset-docstrings
branch
from
fb51e29
to
127dd80
Compare
pitrou
force-pushed
the
ARROW-7430-dataset-docstrings
branch
from
127dd80
to
4e8fa9f
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.