[iceberg] branch master updated: Python: Add more pyiceberg docs (#6874)

[fo...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

fokko pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/iceberg.git


The following commit(s) were added to refs/heads/master by this push:
     new 42d209f491 Python: Add more pyiceberg docs (#6874)
42d209f491 is described below

commit 42d209f491733c412748706fe99756d8767ed3ee
Author: Luigi Cerone <lu...@gmail.com>
AuthorDate: Mon Feb 20 12:17:47 2023 +0100

    Python: Add more pyiceberg docs (#6874)
---
 python/mkdocs/docs/api.md | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/python/mkdocs/docs/api.md b/python/mkdocs/docs/api.md
index f6a7b0f646..a3d6edf015 100644
--- a/python/mkdocs/docs/api.md
+++ b/python/mkdocs/docs/api.md
@@ -19,7 +19,7 @@
 
 # Python API
 
-PyIceberg is based around catalogs to load tables. First step is to instantiate a catalog that loads tables. Let's use the following configuration:
+PyIceberg is based around catalogs to load tables. First step is to instantiate a catalog that loads tables. Let's use the following configuration to define a catalog called `prod`:
 
 ```yaml
 catalog:
@@ -28,6 +28,10 @@ catalog:
     credential: t-1234:secret
 ```
 
+These info must be placed inside a file called `.pyiceberg.yaml` located either in the `$HOME` directory or in the `$PYICEBERG_HOME` directory (if var is set).
+
+For more details on possible configurations refer to the [specific page](https://py.iceberg.apache.org/configuration/).
+
 Then load the `prod` catalog:
 
 ```python