From e3d1a6390e2177bb6b488d13468a8f7e1a10464c Mon Sep 17 00:00:00 2001 From: Kevin Liu Date: Tue, 11 Feb 2025 20:00:08 -0800 Subject: [PATCH] reword docs and make lint --- mkdocs/docs/configuration.md | 4 ++-- tests/utils/test_config.py | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/mkdocs/docs/configuration.md b/mkdocs/docs/configuration.md index 6934045fab..ce7b05f69d 100644 --- a/mkdocs/docs/configuration.md +++ b/mkdocs/docs/configuration.md @@ -28,11 +28,11 @@ hide: There are three ways to pass in configuration: -- Using the `.pyiceberg.yaml` configuration file stored in either the directory specified by the `PYICEBERG_HOME` environment variable, the home directory, or current working directory. +- Using the `.pyiceberg.yaml` configuration file (Recommended) - Through environment variables - By passing in credentials through the CLI or the Python API -The configuration file is recommended since that's the easiest way to manage the credentials. +The configuration file can be stored in either the directory specified by the `PYICEBERG_HOME` environment variable, the home directory, or current working directory (in this order). To change the path searched for the `.pyiceberg.yaml`, you can overwrite the `PYICEBERG_HOME` environment variable. diff --git a/tests/utils/test_config.py b/tests/utils/test_config.py index 010f9a7c9b..adc5fa824b 100644 --- a/tests/utils/test_config.py +++ b/tests/utils/test_config.py @@ -164,6 +164,6 @@ def create_config_files( if config_setup.get("config_location") in ["current", "both"]: monkeypatch.chdir(paths["current"]) - assert Config()._from_configuration_files() == expected_result, ( - f"Unexpected configuration result for content: {expected_result}" - ) + assert ( + Config()._from_configuration_files() == expected_result + ), f"Unexpected configuration result for content: {expected_result}"