Skip to content

[Docs] Update faq.md #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
haochengxia merged 1 commit into from
Aug 4, 2025
Merged

[Docs] Update faq.md #28

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion docs/src/en/faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,19 @@

1. How to resolve when pip install fails?

See [installation](https://cachemon.github.io/libCacheSim-python/getting_started/installation/).
See [installation](https://cachemon.github.io/libCacheSim-python/getting_started/installation/).

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.
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Aug 4, 2025

Choose a reason for hiding this comment

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

medium

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.

Suggested change
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.


If you can install software directly,

```shell
[sudo] apt install python3-dev
```
Comment on lines +11 to +15
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Aug 4, 2025

Choose a reason for hiding this comment

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

medium

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.

Suggested change
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.

If not, please install Python somewhere and set environment variables to help the building system find them.
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Aug 4, 2025

Choose a reason for hiding this comment

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

medium

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.

Suggested change
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.


```shell
export CMAKE_ARGS="-DPython3_ROOT_DIR=${Python3_ROOT_DIR} -DPython3_INCLUDE_DIR=${Python3_INCLUDE_DIR} -DPython3_EXECUTABLE=${Python3_EXECUTABLE}"
```