local-group / rust-escposify

A ESC/POS driver in Rust ( Documentation: https://docs.rs/escposify )
MIT License
52 stars 18 forks source link

Added documentation #12

Closed hgrahamcs closed 1 year ago

hgrahamcs commented 1 year ago

The documentation in docs.rs for escposify is lacking. I've added another example using std::fs::File to improve clarity as well as added usage examples to device::File::from() and printer::Printer.

TheWaWaR commented 1 year ago

Please see how to write doc first.

https://doc.rust-lang.org/rustdoc/how-to-write-documentation.html https://doc.rust-lang.org/rust-by-example/meta/doc.html

hgrahamcs commented 1 year ago

Would you prefer line comments instead of block comments for documentation?

TheWaWaR commented 1 year ago

Would you prefer line comments instead of block comments for documentation?

Yes. Because all my projects use line comments.

hgrahamcs commented 1 year ago

Changed in 9fa0f95.

ipetrovbg commented 1 year ago

This line saved me a lot of troubles under Linux.

File::options().append(true).open("/dev/usb/lp0").unwrap();

hgrahamcs commented 1 year ago

I'm glad I could help!

hgrahamcs commented 1 year ago

@TheWaWaR any progress on reviewing this PR?

hgrahamcs commented 1 year ago

Do we need to bump to 0.5.2?

TheWaWaR commented 1 year ago

Yes, we should.

hgrahamcs commented 1 year ago

13 has a bump