Skip to content

docs: clarify environment configuration overrides - #2324

Merged
martindurant merged 2 commits into
fsspec:masterfrom
Mohamedajab:docs/configuration-environment
Oct 19, 2026
Merged

martindurant merged 2 commits into
fsspec:masterfrom
Mohamedajab:docs/configuration-environment

Conversation

@Mohamedajab

Copy link
Copy Markdown
Contributor

The configuration guide uses FSSPEC_CONFIG_DIRECTORY in its precedence list, but the implementation reads FSSPEC_CONFIG_DIR. It also describes per-option environment values as strings, although valid JSON values are decoded.

Use the correct directory variable, explain that environment settings must be present before import, and add a short boolean-override example. No runtime behaviour changes.

Validation:

  • All 8 configuration tests passed.
  • Checked the example's boolean value and override order, and the directory setting in a fresh Python process.
  • Pre-commit and git diff --check passed.
  • Sphinx HTML build completed. It reported warnings in unchanged docstrings and an existing changelog entry; this was not a warning-free build.

@martindurant
martindurant merged commit a46dfd7 into fsspec:master Oct 19, 2026
11 checks passed
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.

2 participants