From f91936b06e2beca8f47797dcc7c3bdd780119e2a Mon Sep 17 00:00:00 2001 From: "Yukihiro \"Matz\" Matsumoto" Date: Mon, 11 May 2026 10:56:00 +0900 Subject: [PATCH] hw-spi: keep splat parameter notation unescaped in README The previous commit's prettier pass escaped `*data` to `\*data` in the SPI#write / SPI#transfer method signatures. The escape is defensive (prettier avoids any standalone `*` to dodge italic misparses) but unnecessary in these positions: GFM only treats `*` as italic when paired with a closing `*`, which never happens in a method signature. The unescaped form reads more naturally to Ruby users. 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 aae5233cf..50d5e78af 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.