From 9a95e2719c6ff25cce17c50064b1f290f6391a9d Mon Sep 17 00:00:00 2001 From: Yuan Yu Date: Wed, 13 Aug 2025 15:35:02 +0800 Subject: [PATCH] docs(twai): update example description for TWAI utilities --- docs/en/api-reference/peripherals/twai.rst | 2 +- docs/zh_CN/api-reference/peripherals/twai.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/en/api-reference/peripherals/twai.rst b/docs/en/api-reference/peripherals/twai.rst index 0a8c4070b1..f10bf89c02 100644 --- a/docs/en/api-reference/peripherals/twai.rst +++ b/docs/en/api-reference/peripherals/twai.rst @@ -371,7 +371,7 @@ Application Examples .. list:: - - Temporary no. + - :example:`peripherals/twai/twai_utils` demonstrates how to use the TWAI (Two-Wire Automotive Interface) APIs to create a command-line interface for TWAI bus communication, supporting frame transmission/reception, filtering, monitoring, and both classic and FD formats for testing and debugging TWAI networks. API Reference ------------- diff --git a/docs/zh_CN/api-reference/peripherals/twai.rst b/docs/zh_CN/api-reference/peripherals/twai.rst index 6547c08e53..c6050e23ae 100644 --- a/docs/zh_CN/api-reference/peripherals/twai.rst +++ b/docs/zh_CN/api-reference/peripherals/twai.rst @@ -371,7 +371,7 @@ TWAI控制器能够检测由于总线干扰产生的/损坏的不符合帧格式 .. list:: - - 暂无 + - :example:`peripherals/twai/twai_utils` 演示了如何使用 TWAI(Two-Wire Automotive Interface,双线汽车接口)API 创建一个命令行工具,用于 TWAI 总线通信,支持帧的发送/接收、过滤、监控,以及经典和 FD 格式,以便测试和调试 TWAI 网络。 API 参考 --------