diff --git a/CHANGELOG.md b/CHANGELOG.md index b2f362d0..e341fd89 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,10 @@ project adheres to [Semantic Versioning](https://semver.org/). ## [Unreleased] ### Added + +* Add recommendation on how to interpret `UsbPortInfo::interface_number`. + [#219](https://github.com/serialport/serialport-rs/pull/219) + ### Changed ### Fixed ### Removed diff --git a/src/lib.rs b/src/lib.rs index 15e0457e..79d0f377 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -787,7 +787,9 @@ pub struct UsbPortInfo { pub manufacturer: Option, /// Product name (arbitrary string) pub product: Option, - /// Interface (id number for multiplexed devices) + /// The interface index of the USB serial port. This can be either the interface number of + /// the communication interface (as is the case on Windows and Linux) or the data + /// interface (as is the case on macOS), so you should recognize both interface numbers. #[cfg(feature = "usbportinfo-interface")] pub interface: Option, }