diff --git a/src/lib.rs b/src/lib.rs index 553309b..8fa2b36 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -177,6 +177,13 @@ pub fn list_devices() -> Result, Error> { /// } /// } /// ``` +/// +/// ### Platform-specific notes: +/// +/// * On Windows, the interfaces of a composite device might not be ready +/// when the `Connected` event is emitted. If you are immediately opening the device +/// and claiming an interface when receiving a `Connected` event, +/// you should retry after a short delay if opening or claiming fails. pub fn watch_devices() -> Result { Ok(hotplug::HotplugWatch(platform::HotplugWatch::new()?)) }