Fix the reason for calling a file lib.rs #18140
Conversation
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @huonw (or someone else) soon. |
| and so it's named this, by convention. | ||
| We're calling this file `lib.rs` so Cargo knows it is a file that contains the | ||
| library functions for this crate. This way we can use the functions in other | ||
| files in the project in an easy way. |
There was a problem hiding this comment.
I would say that it's still a convention, just one that Cargo knows about.
There was a problem hiding this comment.
Agreed.
And also agreed that the sentence is a bit off. How about this:
We're calling this file
lib.rsbecause by convention, Cargo uses that filename as the crate root for this crate.
|
@JelteF what's your status? |
|
Sorry, forgot about this a bit. The sentence suggestest by steveklabnik sounds good as well. I would move the by convention to the end of the sentenc however, since it reads a bit weard now. Will change the pull request to reflect that somewhere next week. So it would become this: We're calling this file |
|
Bump, @JelteF. Do you want someone else to carry this forward? |
|
Fixed the sentence, sorry it took so long. |
The reason given didn't make any sense when I read it when reading through the docs. I think this is more clear. Please let me know it is also more correct.
The reason given didn't make any sense when I read it when reading through the docs. I think this is more clear. Please let me know it is also more correct.