Skip to content

Commit a72d478

Browse files
committed
docs: add docs on new .pyiceberg.yaml search path
1 parent 473ef5a commit a72d478

2 files changed

Lines changed: 2 additions & 2 deletions

File tree

mkdocs/docs/api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ catalog:
4949

5050
and loaded in python by calling `load_catalog(name="hive")` and `load_catalog(name="rest")`.
5151

52-
This information must be placed inside a file called `.pyiceberg.yaml` located either in the `$HOME` or `%USERPROFILE%` directory (depending on whether the operating system is Unix-based or Windows-based, respectively) or in the `$PYICEBERG_HOME` directory (if the corresponding environment variable is set).
52+
This information must be placed inside a file called `.pyiceberg.yaml` located either in the `$HOME` or `%USERPROFILE%` directory (depending on whether the operating system is Unix-based or Windows-based, respectively), in the current working directory, or in the `$PYICEBERG_HOME` directory (if the corresponding environment variable is set).
5353

5454
For more details on possible configurations refer to the [specific page](https://py.iceberg.apache.org/configuration/).
5555

mkdocs/docs/cli.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ hide:
2626

2727
Pyiceberg comes with a CLI that's available after installing the `pyiceberg` package.
2828

29-
You can pass the path to the Catalog using the `--uri` and `--credential` argument, but it is recommended to setup a `~/.pyiceberg.yaml` config as described in the [Catalog](configuration.md) section.
29+
You can pass the path to the Catalog using the `--uri` and `--credential` argument, but it is recommended to setup a `~/.pyiceberg.yaml` or `./.pyiceberg.yaml` config as described in the [Catalog](configuration.md) section.
3030

3131
```sh
3232
➜ pyiceberg --help

0 commit comments

Comments
 (0)