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/04/05 13:06:58 UTC

[GitHub] [arrow] AlenkaF commented on a diff in pull request #12796: ARROW-16079: [Python] Address docstrings in Parquet schema and metadata

AlenkaF commented on code in PR #12796:
URL: https://github.com/apache/arrow/pull/12796#discussion_r842762929


##########
python/pyarrow/parquet.py:
##########
@@ -2412,6 +2412,23 @@ def read_metadata(where, memory_map=False, decryption_properties=None):
     Returns
     -------
     metadata : FileMetadata
+
+    Examples
+    --------
+    >>> import pyarrow as pa
+    >>> import pyarrow.parquet as pq
+    >>> table = pa.table({'n_legs': [4, 5, 100],
+    ...                   'animal': ["Dog", "Brittle stars", "Centipede"]})
+    >>> pq.write_table(table, 'example.parquet')
+
+    >>> pq.read_metadata('example.parquet')
+    <pyarrow._parquet.FileMetaData object at ...>
+      created_by: parquet-cpp-arrow version 8.0.0-SNAPSHOT

Review Comment:
   Will correct, thanks!



-- 
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