Move crate-level docs to README and import with include_str

worm-blossom / ufotofu

Abstractions for lazily consuming and producing sequences in Rust.

Apache License 2.0

3 stars 1 forks source link

Move crate-level docs to README and import with include_str #24

Closed mycognosist closed 4 months ago

mycognosist commented 4 months ago

Just a suggestion; feel free to ignore.

We could move the existing crate-level docs in src/lib.rs to README.md and then simply import them in src/lib.rs with #![doc = include_str!("../README.md")]. Then we have parity between crate-level docs and README.

AljoschaMeyer commented 4 months ago

Huh, I didn't know about that. Works for me!

mycognosist commented 4 months ago

Cool. I'll open a PR.

mycognosist commented 4 months ago

Addressed in https://github.com/worm-blossom/ufotofu/pull/25