Skip to content

docs: correct optional dependency installation examples - #330

Open
Likio3000 wants to merge 1 commit into
cdgriffith:developfrom
Likio3000:docs/correct-optional-install-examples-20260923
Open

Likio3000 wants to merge 1 commit into
cdgriffith:developfrom
Likio3000:docs/correct-optional-install-examples-20260923

Conversation

@Likio3000

Copy link
Copy Markdown

The selected-dependencies example uses tomli_w, which is not a declared extra, and therefore does not install the same TOML dependency as [all]. Use toml to match setup.py, and document tomli as the extra that installs tomli-w.

Quote the package specifications in all three shell commands so the brackets reach pip unchanged instead of being interpreted as filename patterns, including by zsh. The requirements.txt example remains unquoted. Added a changelog note and contributor entry as requested by CONTRIBUTING.rst; this targets develop.

Validation: inspected setup.py as an AST and confirmed the declared extras and their dependencies; read TOML backend selection in box/converters.py; reviewed the exact documentation diff and source blob hashes. I did not install the package, execute setup.py, or run the project test suite. Runtime code is unchanged.

AI assistance: prepared using OpenAI Codex and reviewed against the repository's source and contribution guide.

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.

1 participant