[riot-notifications] [RIOT-OS/RIOT] drivers/include/periph/spi: fix documentation (#11944)

benpicco notifications at github.com
Wed Jul 31 12:39:31 CEST 2019


### Contribution description
The documentation for `spi_transfer_reg()` seems to have been copied from `spi_transfer_regs()`.
Here a `NULL` parameter makes sense to indicate that the Bytes to be send during a SPI transfer do not matter and will be '0'.

`spi_transfer_reg()`  however doesn't take a pointer but a single byte as an argument, so using `NULL` as a parameter makes no sense. In fact, the byte specified there will always be send as this is just how SPI works. So just drop that part of the sentence.

### Testing procedure
No functional change is expected.

### Issues/PRs references
fixes #11763

You can view, comment on, or merge this pull request online at:

  https://github.com/RIOT-OS/RIOT/pull/11944

-- Commit Summary --

  * drivers/include/periph/spi: fix documentation

-- File Changes --

    M drivers/include/periph/spi.h (2)

-- Patch Links --

https://github.com/RIOT-OS/RIOT/pull/11944.patch
https://github.com/RIOT-OS/RIOT/pull/11944.diff

-- 
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/RIOT-OS/RIOT/pull/11944
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.riot-os.org/pipermail/notifications/attachments/20190731/2ad415d6/attachment.htm>


More information about the notifications mailing list