[Docs] Update faq.md #28
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 focuses on improving the project's documentation by expanding the FAQ section. The primary goal is to provide clear guidance and troubleshooting steps for users encountering specific Python-related build errors, making the project more accessible and reducing common friction points during setup.
Highlights
- Documentation Enhancement: I've added a new entry to the
faq.mdfile to address a common build issue where the system cannot find Python packages. - Build Troubleshooting Guide: The new FAQ entry provides two primary solutions for the 'cannot find Python package' error: installing
python3-devviaaptand configuring CMake environment variables (CMAKE_ARGS) for custom Python installations. - Formatting Correction: I've also made a minor formatting adjustment by correcting the indentation for the answer to the first FAQ question.
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 adds a new FAQ entry addressing a common build issue related to missing Python development files. The review focuses on enhancing the clarity, accuracy, and completeness of the instructions, including suggestions for multiple operating systems and more precise explanations.
| 2. Get an error message like "cannot find Python package" when building. | ||
|
|
||
| The reason is that when building a Python binding package, we need the header and other necessary modules. |
There was a problem hiding this comment.
The sentence 'The reason is that when building a Python binding package, we need the header and other necessary modules.' could be more precise. Consider rephrasing to clearly state the requirement for Python development headers and libraries.
| The reason is that when building a Python binding package, we need the header and other necessary modules. | |
| The reason is that building Python bindings requires Python's development headers and libraries. |
|
|
||
| ```shell | ||
| [sudo] apt install python3-dev | ||
| ``` |
There was a problem hiding this comment.
The instruction to install software directly is vague and only provides a Debian/Ubuntu example. Consider expanding this to include instructions for other common operating systems like RHEL/CentOS/Fedora and macOS.
| If you can install software directly, | |
| ```shell | |
| [sudo] apt install python3-dev | |
| ``` | |
| 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` | |
| * **macOS**: Installing Python with Homebrew (`brew install python`) is usually sufficient. |
| [sudo] apt install python3-dev | ||
| ``` | ||
| If not, please install Python somewhere and set environment variables to help the building system find them. |
There was a problem hiding this comment.
The phrase 'If not, please install Python somewhere and set environment variables to help the building system find them.' is ambiguous. Clarify that this applies when Python is installed in a custom location and remind users to replace placeholders in the subsequent command.
| If not, please install Python somewhere and set environment variables to help the building system find them. | |
| Alternatively, if you installed Python in a custom location, you must set environment variables to help the build system find it. Remember to replace the placeholders in the command below with your actual paths. |
No description provided.