Fix cargo doc warning by explicitly matching /README.md in Cargo.toml

sunjay / turtle

Create Animated Drawings in Rust

http://turtle.rs

Mozilla Public License 2.0

562 stars 53 forks source link

Fix cargo doc warning by explicitly matching /README.md in Cargo.toml #95

Closed zachlute closed 6 years ago

zachlute commented 6 years ago

Fixes Issue #91

sunjay commented 6 years ago

Thank you for fixing this! Could you explain what the change was so I know for the future?

zachlute commented 6 years ago

Basically, there are two README.md files in turtle, the one at /README.md and the one at /docs/README.md. Previously, the include match in Cargo.toml would match only the root one, but it's being changed so the pattern matches ANY file unless the pattern explicitly matches the root.

So by changing Cargo.toml to match /README.md explicitly, the warning is no longer produced because only one file matches.

(At least, that is my understanding.)

sunjay commented 6 years ago

Thank you this is great!