Skip to content

Commit 3a26de9

Browse files
committed
Docs edits
1 parent 0a9b493 commit 3a26de9

File tree

2 files changed

+7
-5
lines changed

2 files changed

+7
-5
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,12 @@ A new pure-Rust library for cross-platform low-level access to USB devices.
1515
that is started when opening the first device.
1616
* Thinner layer over OS APIs, with less internal state.
1717

18-
### :construction: Current status
18+
### Current status
1919

2020
* Support for Linux, Windows, and macOS
21-
* Control, bulk and interrupt transfers work
22-
* Minimally tested: please test with your device and report issues
21+
* Device listing and descriptor parsing
22+
* Transfers on control, bulk and interrupt endpoints
23+
* Used in production by [probe-rs](https://github.com/probe-rs/probe-rs) and others, but still relatively new. Please test with your device and report issues.
2324

2425
### License
2526
MIT or Apache 2.0, at your option

src/transfer/queue.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -216,8 +216,9 @@ where
216216
/// device to reset the endpoint's data toggle and clear the halt / stall
217217
/// condition, and resets the host-side data toggle.
218218
///
219-
/// Use this after receiving [`TransferError::Stall`] to clear the error and
220-
/// resume use of the endpoint.
219+
/// Use this after receiving
220+
/// [`TransferError::Stall`][crate::transfer::TransferError::Stall] to clear
221+
/// the error and resume use of the endpoint.
221222
///
222223
/// This should not be called when transfers are pending on the endpoint.
223224
pub fn clear_halt(&mut self) -> Result<(), Error> {

0 commit comments

Comments
 (0)