[Docs] refine instructions in FAQ #29
Conversation
There was a problem hiding this comment.
Summary of Changes
Hello @haochengxia, 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 significantly enhances the clarity and comprehensiveness of the FAQ section related to Python package build errors. The changes aim to provide users with more precise explanations and actionable, platform-specific steps to resolve common build issues, particularly concerning Python development dependencies.
Highlights
- Improved Clarity for Python Build Errors: I've refined the explanation for the 'cannot find Python package' error, clarifying that Python's development headers and libraries are essential for building Python bindings.
- Expanded Platform-Specific Installation Instructions: I've added detailed, platform-specific commands for installing Python development packages, now covering Debian/Ubuntu (
apt install python3-dev), RHEL/CentOS/Fedora (yum install python3-devel), and macOS (Homebrew). - Enhanced Guidance for Custom Python Installations: I've updated the instructions for users with custom Python installations, providing clearer guidance on setting
CMAKE_ARGSenvironment variables to help the build system locate Python.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| 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 issue 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 or fill out our survey to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
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. ↩
There was a problem hiding this comment.
Code Review
This pull request significantly improves the FAQ section on resolving Python package build errors. The instructions are now much clearer and provide specific commands for different operating systems, which is a great enhancement for users. I have one minor suggestion to improve the accuracy of the command for RHEL-based distributions.
| If you can install software directly, | ||
| If you have administrative privileges, you can use your system's package manager to install the required package. For example: | ||
| * **Debian/Ubuntu**: `sudo apt install python3-dev` | ||
| * **RHEL/CentOS/Fedora**: `sudo yum install python3-devel` |
There was a problem hiding this comment.
While yum is correct for older RHEL/CentOS versions (like 7), modern versions (8+) and recent Fedora releases use dnf as the default package manager. Using dnf in the documentation would be more accurate for a larger set of users. On many systems where dnf is standard, yum is an alias to dnf, but it's better to be explicit and use the modern tool.
| * **RHEL/CentOS/Fedora**: `sudo yum install python3-devel` | |
| * **RHEL/CentOS/Fedora**: `sudo dnf install python3-devel` |
No description provided.