From 79018d4f0092c6d9635cf567954aea05b938bdd8 Mon Sep 17 00:00:00 2001 From: Galen Nickel Date: Tue, 30 Jan 2018 08:54:42 -0800 Subject: [PATCH] Enable help for serial readString() (#609) --- docs/reference/serial/read-string.md | 4 ++-- libs/core/serial.cpp | 1 + 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/reference/serial/read-string.md b/docs/reference/serial/read-string.md index ee449ed2..281d0eef 100644 --- a/docs/reference/serial/read-string.md +++ b/docs/reference/serial/read-string.md @@ -1,6 +1,6 @@ # Serial Read String -Read the buffered serial data as a string +Read the buffered serial data as a string. ```sig serial.readString(); @@ -8,7 +8,7 @@ serial.readString(); ## Returns -* a [string](/types/string) containing input from the serial port. Empty if no data available. +* a [string](/types/string) containing input from the serial port. The string is empty if no data is available. ## Example diff --git a/libs/core/serial.cpp b/libs/core/serial.cpp index a01813db..b201660a 100644 --- a/libs/core/serial.cpp +++ b/libs/core/serial.cpp @@ -75,6 +75,7 @@ namespace serial { /** * Reads the buffered received data as a string */ + //% help=serial/read-string //% blockId=serial_read_buffer block="serial|read string" //% weight=18 StringData* readString() {