rustdoc icon indicating copy to clipboard operation
rustdoc copied to clipboard

New Rustdoc can't document individual rs files

Open euclio opened this issue 7 years ago • 3 comments

I think there's a bit of an mismatch between the fact that old rustdoc allows documenting individual files while the new rustdoc expects a crate with Cargo.toml. How do we want to handle that?

Another way of putting it is that the old rustdoc expects to be wrapped by cargo, while the new rustdoc expects to wrap cargo.

cc #125

euclio avatar Aug 11 '17 20:08 euclio

steveklabnik avatar Aug 14 '17 21:08 steveklabnik

Are we talking about the same thing? I originally opened the issue intending to talk about individual Rust files, not markdown. You can invoke the old rustdoc like rustdoc some_file.rs and it will create documentation for that file, without needing a Cargo.toml. Not saying we need to support that use case, but I'd like us to make an official decision.

euclio avatar Aug 14 '17 21:08 euclio

Oh!

Since that's just a crate root, yeah, okay. Let me change the title again; I misunderstood.

steveklabnik avatar Aug 14 '17 22:08 steveklabnik