From 3e2ce88eab113a9346ff1425039c70270b538090 Mon Sep 17 00:00:00 2001 From: "Yukihiro \"Matz\" Matsumoto" Date: Wed, 20 May 2026 08:34:28 +0900 Subject: [PATCH] hw-spi: wrap splat-bearing method signatures as code in README After f91936b06e kept the splat notation unescaped, prettier kept flagging the standalone `*` in the SPI#write / SPI#transfer headings every CI run. Wrap the two signatures in backticks so prettier treats them as inline code (which they are), and the `*data` form stays unescaped without further conflict. Same convention is already used in mruby-kernel-ext/README.md (e.g. `### \`fail(*args)\``). Co-authored-by: Claude --- mrbgems/hw-spi/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/mrbgems/hw-spi/README.md b/mrbgems/hw-spi/README.md index 50d5e78af..a29403bc5 100644 --- a/mrbgems/hw-spi/README.md +++ b/mrbgems/hw-spi/README.md @@ -50,7 +50,7 @@ spi = SPI.new( \*SPI3 availability depends on ESP32 variant. -### SPI#write(*data) +### `SPI#write(*data)` Write data to the SPI bus. Data can be Integer, Array, or String. @@ -68,7 +68,7 @@ data = spi.read(4) # transmits 0x00 while reading data = spi.read(4, 0xFF) # transmits 0xFF while reading ``` -### SPI#transfer(*data, additional_read_bytes: 0) +### `SPI#transfer(*data, additional_read_bytes: 0)` Full-duplex transfer. Sends data and returns received bytes. Use `additional_read_bytes:` to append zero-filled read bytes.