admin/mruby-mruby
1
0
Fork 0
mirror of https://github.com/mruby/mruby synced 2026-06-08 16:11:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

hw-spi: wrap splat-bearing method signatures as code in README

Browse Source 
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 <noreply@anthropic.com>
This commit is contained in:
Yukihiro "Matz" Matsumoto
2026-05-20 08:34:28 +09:00
parent 7378be58cb
commit 3e2ce88eab
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
mrbgems/hw-spi/README.md
+2 -2
View File
@@ -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.