docs: Fix hallucination in CRC description #9
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR corrects the CRC16 parameters in the Bluetooth spec docs, clarifies Hamming Distance protection, and adds a reference link for further reading.
- Swapped the initial value and polynomial to the correct settings.
- Annotated the polynomial with its Hamming Distance 4 protection range.
- Appended a reference link to Carnegie Mellon’s CRC page.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| doc/bluetooth_specification.ja.md | Updated CRC16 parameters, Hamming note, and added a reference link |
| doc/bluetooth_specification.md | Applied the same CRC16 corrections and reference in English |
| doc/bluetooth_specification.zh-CN.md | Mirrored CRC16 fixes, Hamming note, and reference in Simplified Chinese |
| - Input: bytecode buffer | ||
| - Length: bytecode length | ||
|
|
||
| Reference: https://users.ece.cmu.edu/~koopman/crc/index.html |
There was a problem hiding this comment.
[nitpick] Use standard Markdown link syntax for clarity, for example:
Reference: Carnegie Mellon University CRC Page
| Reference: https://users.ece.cmu.edu/~koopman/crc/index.html | |
| Reference: [Carnegie Mellon University CRC Page](https://users.ece.cmu.edu/~koopman/crc/index.html) |
Copilot uses AI. Check for mistakes.
| - 输入：字节码缓冲区 | ||
| - 长度：字节码长度 | ||
|
|
||
| 参考文献: https://users.ece.cmu.edu/~koopman/crc/index.html |
There was a problem hiding this comment.
[nitpick] 在“参考文献”后使用中文全角冒号“：”以符合中文标点习惯，并考虑将 URL 转为 Markdown 链接格式以提高可读性。
| 参考文献: https://users.ece.cmu.edu/~koopman/crc/index.html | |
| 参考文献：https://users.ece.cmu.edu/~koopman/crc/index.html |
Copilot uses AI. Check for mistakes.
| - 入力：バイトコードバッファ | ||
| - 長さ：バイトコード長 | ||
|
|
||
| 参考文献: https://users.ece.cmu.edu/~koopman/crc/index.html |
There was a problem hiding this comment.
[nitpick] 「参考文献」の後には全角コロン「：」を使い、URL は Markdown リンク形式に変更すると可読性が向上します。
| 参考文献: https://users.ece.cmu.edu/~koopman/crc/index.html | |
| 参考文献：https://users.ece.cmu.edu/~koopman/crc/index.html |
Copilot uses AI. Check for mistakes.
| @@ -134,7 +134,9 @@ The maximum bytecode size is defined by `BLINK_MAX_BYTECODE_SIZE` in the impleme | |||
|
|
|||
| CRC16 checksum is calculated using the `crc16_reflect` function with the following parameters: | |||
|
|
|||
| - Initial value: 0xd175 | |||
| - Polynomial: 0xFFFF | |||
| - Initial value: 0xFFFF | |||
There was a problem hiding this comment.
[nitpick] 当前列表项有的使用“--”有的使用“-”，建议统一为标准 Markdown 列表前缀（例如“- ”）并保持缩进一致。
Copilot uses AI. Check for mistakes.
This pull request updates the CRC16 checksum calculation details in the Bluetooth specification documentation across multiple language versions. The changes ensure consistency in the initial value and polynomial parameters, and provide additional context about the Hamming Distance protection. A reference link has also been added for further information.
Documentation updates for CRC16 checksum:
doc/bluetooth_specification.ja.md: Updated the initial value to0xFFFFand the polynomial to0xd175, with an explanation of Hamming Distance 4 protection for data lengths up to 32751 bits. Added a reference link to Carnegie Mellon University's CRC page.doc/bluetooth_specification.md: Made the same updates as above for the English version of the documentation.doc/bluetooth_specification.zh-CN.md: Applied the same changes to the Simplified Chinese version of the documentation.