From 1b8df6ab26242f6f019297cc86885103119ab1fe Mon Sep 17 00:00:00 2001 From: G2-Games Date: Thu, 8 Feb 2024 03:04:49 -0600 Subject: [PATCH] Fixed documentation errors --- .gitignore | 2 ++ src/lib.rs | 2 +- src/usb.rs | 3 +-- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index 46bb844..5c7f7e3 100644 --- a/.gitignore +++ b/.gitignore @@ -7,5 +7,7 @@ wasm-pack.log www + +.xwin-cache/ .travis .appveyor diff --git a/src/lib.rs b/src/lib.rs index 8ede518..a5df1ab 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -60,7 +60,7 @@ pub use crate::context::UsbDevice; pub use crate::context::UsbInterface; /// Information about a USB device for finding it while trying -/// to look for new USB devices using [get_device_filter] +/// to look for new USB devices using [get_device] #[doc(inline)] pub use crate::context::DeviceFilter; diff --git a/src/usb.rs b/src/usb.rs index 6b2d63e..06b5b1b 100644 --- a/src/usb.rs +++ b/src/usb.rs @@ -20,8 +20,7 @@ pub trait Device { /// request a new device with [crate::get_device] or [crate::get_device_filter] async fn reset(&self) -> Result<(), UsbError>; - /// Remove the device from the paired devices list, causing it to no longer be usable. - /// You must request to reconnect using [crate::get_device] or [crate::get_device_filter] + /// Remove the device from the paired devices list, causing it to no longer be usable. You must request to reconnect using [crate::get_device] /// /// **Note: on Native with `nusb` this simply resets the device** async fn forget(&self) -> Result<(), UsbError>;