From 4c89061e0e79ccd8574c058e30d9b694f22ced1b Mon Sep 17 00:00:00 2001 From: David Sanders Date: Mon, 5 Jun 2023 14:58:30 +0800 Subject: [PATCH] docs: fix SerialPort typing (#38544) --- docs/api/structures/serial-port.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/api/structures/serial-port.md b/docs/api/structures/serial-port.md index 052b961141c2..21d607c8827b 100644 --- a/docs/api/structures/serial-port.md +++ b/docs/api/structures/serial-port.md @@ -2,9 +2,9 @@ * `portId` string - Unique identifier for the port. * `portName` string - Name of the port. -* `displayName` string - A string suitable for display to the user for describing this device. -* `vendorId` string - Optional USB vendor ID. -* `productId` string - Optional USB product ID. -* `serialNumber` string - The USB device serial number. -* `usbDriverName` string (optional) - Represents a single serial port on macOS can be enumerated by multiple drivers. -* `deviceInstanceId` string (optional) - A stable identifier on Windows that can be used for device permissions. +* `displayName` string (optional) - A string suitable for display to the user for describing this device. +* `vendorId` string (optional) - The USB vendor ID. +* `productId` string (optional) - The USB product ID. +* `serialNumber` string (optional) - The USB device serial number. +* `usbDriverName` string (optional) _macOS_ - Represents a single serial port on macOS can be enumerated by multiple drivers. +* `deviceInstanceId` string (optional) _Windows_ - A stable identifier on Windows that can be used for device permissions.