Skip to content

Commit

Permalink
Fixed documentation errors
Browse files Browse the repository at this point in the history
  • Loading branch information
G2-Games committed Feb 8, 2024
1 parent e5b0bcc commit 1b8df6a
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 3 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,7 @@ wasm-pack.log

www


.xwin-cache/
.travis
.appveyor
2 changes: 1 addition & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down
3 changes: 1 addition & 2 deletions src/usb.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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>;
Expand Down

0 comments on commit 1b8df6a

Please sign in to comment.