Skip to content

docs: Fix GCS default bucket location key and document s3.ssl.ca-cert - #4179

Open
sarthakuwar wants to merge 1 commit into
apache:mainfrom
sarthakuwar:docs/gcs-default-bucket-location
Open

sarthakuwar wants to merge 1 commit into
apache:mainfrom
sarthakuwar:docs/gcs-default-bucket-location

Conversation

@sarthakuwar

Copy link
Copy Markdown

Rationale for this change

mkdocs/docs/configuration.md documents gcs.default-location, but the code reads a different key:

# pyiceberg/io/__init__.py
GCS_DEFAULT_LOCATION = "gcs.default-bucket-location"

Both PyArrowFileIO (pyiceberg/io/pyarrow.py, passed as default_bucket_location) and FsspecFileIO (pyiceberg/io/fsspec.py, passed as default_location) look up gcs.default-bucket-location. Anyone who sets the documented key gets no error, and the setting is silently ignored.

While there, I added the missing s3.ssl.ca-cert row to the S3 table. It is read in PyArrowFileIO._set_tls_ca_file_path and needs pyarrow 21.0.0 or later (the code raises ImportError otherwise). It is not used by FsspecFileIO.

Are these changes tested?

Docs only. I checked both keys against the constants in pyiceberg/io/__init__.py and where they are read, and ran markdownlint (v0.45.0, the version in .pre-commit-config.yaml) and codespell on the file. Both pass.

Are there any user-facing changes?

Docs only. No code changes.

@rambleraptor rambleraptor left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Easy peasy. Thanks for the fix!

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants