search

tokio-rs / io-uring

The `io_uring` library for Rust
Apache License 2.0
1.16k stars 129 forks source link

`ReadFixed` and `WriteFixed` descriptions #275

Closed connortsui20 closed 4 months ago

connortsui20 commented 4 months ago

https://docs.rs/io-uring/latest/io_uring/opcode/struct.ReadFixed.html

Read from pre-mapped buffers that have been previously registered...

Should this be "Read into pre-mapped buffers" instead of "Read from"?

https://docs.rs/io-uring/latest/io_uring/opcode/struct.WriteFixed.html

Write to pre-mapped buffers that have been previously registered...

Also, should this be "Write from pre-mapped buffers" instead of "Write to"?

I'm pretty sure this is the case, but not 100% sure.

quininer commented 4 months ago

You are right, would you like to open a PR to fix it?

connortsui20 commented 4 months ago

Sure!

It would probably be good for me to take the time to add some more specific documentation that isn't just pointing to man pages. Hopefully I can get those done next month (when my school semester has finished)