From db7963444628cd7c28290b6eb9689c6787ffe5f1 Mon Sep 17 00:00:00 2001 From: "Matthias L. Jugel" Date: Mon, 13 Feb 2017 11:44:00 +0100 Subject: [PATCH] add comments from pxt-microbit --- libs/core/_locales/core-jsdoc-strings.json | 5 +++-- libs/core/shims.d.ts | 6 +++--- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/libs/core/_locales/core-jsdoc-strings.json b/libs/core/_locales/core-jsdoc-strings.json index 685c6b3e..b878b887 100644 --- a/libs/core/_locales/core-jsdoc-strings.json +++ b/libs/core/_locales/core-jsdoc-strings.json @@ -248,8 +248,9 @@ "serial.readUntil": "Reads a line of text from the serial port and returns the buffer when the delimiter is met.", "serial.readUntil|param|delimiter": "text delimiter that separates each text chunk", "serial.redirect": "Dynamically configuring the serial instance to use pins other than USBTX and USBRX.", - "serial.redirect|param|rx": "the new reception pin", - "serial.redirect|param|tx": "the new transmission pins", + "serial.redirect|param|rate": "the new baud rate. eg: 115200", + "serial.redirect|param|rx": "the new reception pin, eg: SerialPin.P1", + "serial.redirect|param|tx": "the new transmission pins, eg: SerialPin.P0", "serial.writeLine": "Prints a line of text to the serial", "serial.writeNumber": "Prints a numeric value to the serial", "serial.writeString": "Sends a piece of text through Serial connection.", diff --git a/libs/core/shims.d.ts b/libs/core/shims.d.ts index 0072bae3..5eb56ef5 100644 --- a/libs/core/shims.d.ts +++ b/libs/core/shims.d.ts @@ -751,9 +751,9 @@ declare namespace serial { /** * Dynamically configuring the serial instance to use pins other than USBTX and USBRX. - * @param tx the new transmission pins - * @param rx the new reception pin - * @param baud the new baud rate. eg: 115200 + * @param tx the new transmission pins, eg: SerialPin.P0 + * @param rx the new reception pin, eg: SerialPin.P1 + * @param rate the new baud rate. eg: 115200 */ //% weight=10 //% help=serial/redirect-to