[
https://issues.apache.org/jira/browse/ARROW-17047?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17565355#comment-17565355
]
Joris Van den Bossche commented on ARROW-17047:
-----------------------------------------------
In addition to better docs, we could also add a {{field()}} method that returns
you a field? (that is more discoverable than {{[]}}, and would be consistent
with a Schema and with StructArray (to get the child array for that field))
> [Python][Docs] Document how to get field from StructType
> --------------------------------------------------------
>
> Key: ARROW-17047
> URL: https://issues.apache.org/jira/browse/ARROW-17047
> Project: Apache Arrow
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 8.0.0
> Reporter: Will Jones
> Priority: Major
>
> It's not at all obvious how to get a particular field from a StructType from
> it's API page:
> https://arrow.apache.org/docs/python/generated/pyarrow.StructType.html#pyarrow.StructType
> We should add an example:
> {code:python}
> struct_type = pa.struct({"x": pa.int32(), "y": pa.string()})
> struct_type[0]
> # pyarrow.Field<x: int32>
> pa.schema(list(struct_type))
> # x: int32
> # y: string
> {code}
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
