Skip to content

docs: clarify python package installation instructions#1352

Open
Craun718 wants to merge 1 commit into
MaaXYZ:mainfrom
Craun718:chore/agent
Open

docs: clarify python package installation instructions#1352
Craun718 wants to merge 1 commit into
MaaXYZ:mainfrom
Craun718:chore/agent

Conversation

@Craun718
Copy link
Copy Markdown
Contributor

@Craun718 Craun718 commented Jun 3, 2026

年年考,年年错.jpg

Summary by Sourcery

文档:

  • 更新英文快速开始指南,明确说明正确的 MaaFramework Python 包名(maafw)以及使用 python -m pip install maafw 的安装命令。
Original summary in English

Summary by Sourcery

Documentation:

  • Update the English quick start guide to explicitly state the correct MaaFramework Python package name (maafw) and installation command using python -m pip install maafw.

Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

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

Hey - 我已经给出了一些总体反馈:

  • 建议把安装相关的说明从伪代码代码块中移出,放到前面的一句简短说明,或者放到一个文档备注/提示框里,这样代码示例就能更专注于用法本身,而不是说明性文字。
  • 句子 “don't install the wrong one” 略显口语化;建议用更中性的表述(例如:“注意:正确的包名是 maafw,而不是 maa。”),这样更符合常见文档的语气。
给 AI Agent 的提示
Please address the comments from this code review:

## Overall Comments
- Consider moving the installation clarification out of the pseudo-code block into a short preceding sentence or a docs note/admonition so the code sample remains focused on usage rather than commentary.
- The sentence "don't install the wrong one" is a bit informal; rephrase more neutrally (e.g., "Note: the correct package name is `maafw`, not `maa`."), which better matches typical documentation tone.

Sourcery 对开源项目免费 —— 如果你觉得我们的评审有帮助,欢迎分享 ✨
帮我变得更有用!请在每条评论上点击 👍 或 👎,我会根据你的反馈改进后续的评审。
Original comment in English

Hey - I've left some high level feedback:

  • Consider moving the installation clarification out of the pseudo-code block into a short preceding sentence or a docs note/admonition so the code sample remains focused on usage rather than commentary.
  • The sentence "don't install the wrong one" is a bit informal; rephrase more neutrally (e.g., "Note: the correct package name is maafw, not maa."), which better matches typical documentation tone.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- Consider moving the installation clarification out of the pseudo-code block into a short preceding sentence or a docs note/admonition so the code sample remains focused on usage rather than commentary.
- The sentence "don't install the wrong one" is a bit informal; rephrase more neutrally (e.g., "Note: the correct package name is `maafw`, not `maa`."), which better matches typical documentation tone.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

```python
# Python 伪代码示例
# 在这之前要先用 `python -m pip install maafw` 安装 MaaFramework 的 Python 包
# 要安装的包不是 `maa` ,是 `maafw` 不要装错了!
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

感觉快速开始文档一上来主要是亮点展示,这里也都是伪代码,没必要说明这个,会分散新读者的注意力

Copy link
Copy Markdown
Contributor Author

@Craun718 Craun718 Jun 3, 2026

Choose a reason for hiding this comment

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

内部具体的示例原本已经有python -m pip install maafw的提示,但是还是有人装错。我怀疑是不是只看了外面的,所以想着要不要多加一点提示。
或者直接把这段示例删了,只给里面的链接?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

这样该怎么样

该部分仅为伪代码示例,不代表实际业务。

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