Add more examples

apache · Oct 23, 2024 · 91ac1eb · 91ac1eb
1 parent e05e527
commit 91ac1eb
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/python/pyarrow/types.pxi b/python/pyarrow/types.pxi
@@ -5722,6 +5722,25 @@ def schema(fields, metadata=None):
     some_int: int32
     some_string: string
 
+    DataTypes can also be passed as strings. The following is equivalent to the
+    above example:
+
+    >>> pa.schema([
+    ...     pa.field('some_int', "int32"),
+    ...     pa.field('some_string', "string")
+    ... ])
+    some_int: int32
+    some_string: string
+
+    Or more concisely:
+
+    >>> pa.schema([
+    ...     ('some_int', "int32"),
+    ...     ('some_string', "string")
+    ... ])
+    some_int: int32
+    some_string: string
+
     Returns
     -------
     schema : pyarrow.Schema