Skip to content

docs(python): swap docs for python.precompiled_arch and python.precompiled_os#8744

Merged
jdx merged 1 commit intojdx:mainfrom
risu729:fix-python-precompiled-docs
Mar 24, 2026
Merged

docs(python): swap docs for python.precompiled_arch and python.precompiled_os#8744
jdx merged 1 commit intojdx:mainfrom
risu729:fix-python-precompiled-docs

Conversation

@risu729
Copy link
Copy Markdown
Contributor

@risu729 risu729 commented Mar 24, 2026

Swaps the default documentation values for python.precompiled_arch and python.precompiled_os in settings.toml, which were accidentally reversed.

Fixes #8737

This bug was introduced in c26370d (#2730).

@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request resolves a documentation inconsistency within the settings.toml file by correcting the default values displayed for Python precompiled architecture and operating system configurations. It also improves the clarity and helpfulness of the architecture setting's documentation, ensuring users have accurate information and guidance.

Highlights

  • Documentation Correction: The default_docs values for python.precompiled_arch and python.precompiled_os settings were swapped to correctly reflect their intended meanings.
  • Enhanced Documentation: Detailed documentation was added for the python.precompiled_arch setting, providing guidance for users with older CPUs and including a reference link for more information.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Mar 24, 2026

Greptile Summary

This PR is a documentation fix that corrects swapped default_docs values between the python.precompiled_arch and python.precompiled_os settings in settings.toml. Additionally, the extended docs field (which describes architecture-specific guidance such as falling back to "x86_64" for older CPUs) was mistakenly placed under precompiled_os and is moved back to precompiled_arch where it semantically belongs.

  • python.precompiled_arch.default_docs is corrected to "x86_64_v3" | "aarch64" (architecture identifiers)
  • python.precompiled_os.default_docs is corrected to "apple-darwin" | "unknown-linux-gnu" | "unknown-linux-musl" (OS identifiers)
  • The extended docs description referencing x86_64 fallback is moved from precompiled_os to precompiled_arch

Confidence Score: 5/5

  • This PR is safe to merge — it is a pure documentation fix with no runtime impact.
  • The change is minimal and clearly correct: architecture identifiers (x86_64_v3, aarch64) now appear under precompiled_arch, OS identifiers (apple-darwin, unknown-linux-gnu, unknown-linux-musl) now appear under precompiled_os, and the extended docs description about CPU fallback is properly scoped to the arch setting. No logic or behavior is affected.
  • No files require special attention.

Important Files Changed

Filename Overview
settings.toml Swaps the incorrectly placed default_docs values between python.precompiled_arch and python.precompiled_os, and moves the extended docs description to the correct precompiled_arch section.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Precompiled Python Binary Selection] --> B[python.precompiled_os]
    A --> C[python.precompiled_arch]
    B --> D[OS values: apple-darwin, unknown-linux-gnu, unknown-linux-musl]
    C --> E[Arch values: x86_64_v3, aarch64]
    C --> F[Docs: fallback to x86_64 for older CPUs]
Loading

Reviews (1): Last reviewed commit: "fix(docs): swap confused default values ..." | Re-trigger Greptile

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the settings.toml file to refine the configuration for Python precompiled binaries. It adjusts the default_docs for python.precompiled_arch and python.precompiled_os to reflect updated architecture and OS options, respectively. A detailed docs field is added for python.precompiled_arch to provide more context and guidance, while an incorrectly placed docs field is removed from python.precompiled_os. The review feedback suggests improving the readability of the newly added docs string for python.precompiled_arch by breaking it into multiple lines.

Comment thread settings.toml
@risu729 risu729 changed the title fix(docs): swap confused default values for python.precompiled_arch and python.precompiled_os docs(python): swap docs for python.precompiled_arch and python.precompiled_os Mar 24, 2026
@jdx jdx merged commit c051a54 into jdx:main Mar 24, 2026
37 checks passed
@risu729 risu729 deleted the fix-python-precompiled-docs branch March 24, 2026 19:00
jdx pushed a commit that referenced this pull request Mar 24, 2026
### 🚀 Features

- **(github)** add github_tokens.toml, git credential fill, and `mise
github token` command by @jdx in
[#8742](#8742)
- **(registry)** add tart by @mnm364 in
[#8727](#8727)

### 🐛 Bug Fixes

- **(python)** respect precompiled flavor when excluding freethreaded
builds by @risu729 in [#8745](#8745)
- **(shim)** revert shims directory check that caused hangs on macOS by
@jdx in
[e1b8ca4](e1b8ca4)

### 📚 Documentation

- **(python)** swap docs for python.precompiled_arch and
python.precompiled_os by @risu729 in
[#8744](#8744)

### 🧪 Testing

- **(test_tool)** redirect stderr to stdout and strip ansi codes by
@risu729 in [#8738](#8738)

### New Contributors

- @rtharston made their first contribution in
[#8731](#8731)
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