[Bug] Documentation suggests using pyhidapi · qmk/qmk_firmware#26047

(3 留言) (0 反應) (0 負責人)C (20,368 star) (43,867 fork)batch import

bughelp wanted

描述

Describe the Bug

Some documentation page shows how to use Python to communicate with a QMK device. It suggests using pyhidapi, which is a bit confusing for those who don't know the naming mess of pyhidapi. In fact, if you follow along and run pip install pyhidapi, you'll end up with some abandoned package version 0.0.2 which for better or worse does not import as import hid.

The documentation page in question: https://docs.qmk.fm/features/rawhid
Documentation source code: https://github.com/qmk/qmk_firmware/blob/master/docs/features/rawhid.md
Wrong Python package: https://pypi.org/project/pyhidapi/
Wrong package's GitHub page: https://github.com/NF6X/pyhidapi

貢獻者指南

技術棧: pythonc
領域: documentation
議題類型: bug
難度: 2
預計時間: under 1 hour
活動狀態: fresh
清晰度: clear
前置要求: Basic Pythonpip usage
新手友善度: 90
研究方向: The issue is about the documentation page at docs/features/rawhid.md suggesting pyhidapi, which is outdated. The fix involves editing that markdown file to recommend the correct hidapi package (e.g., 'pip install hidapi') and updating the import example. Maintainer comments may clarify the preferred package. No linked PRs exist yet.