learning-rust / learning-rust.github.io

Rust Programming Language Tutorials for Everyone!

Home Page:https://learning-rust.github.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Text improvements to "Rust Basics"

thomasaarholt opened this issue · comments

Rust beginner here, coming from Python.

I'm noticing some parts of the text that either have some language errors or could do with clarification. Since my main intention today is to learn some Rust, I'm not creating PRs to fix them all now, but instead gathering them here and then either I or maybe someone else can go through them later.

Updating as I go:

  • Basics -> Cargo: "But mainly it uses for," is an odd rather empty sentence. The following bullet points don't really fit in with the idea of a package manager either. I'm familiar with package managers that let me download and install software others have written (i.e. matplotlib). This section appears to be concerned with creating projects to share with others? Maybe that should be moved to after the reader has downloaded some packages?

  • Basics -> Comments: "Never use block comments" does not teach me why not. What is the difference between module and crate level documentation? Maybe move the latter discussion to later rather than confuse now?

I was mainly worked on new section about error handling past months. Will check this within this month :)

Hi @thomasaarholt ,
Sorry for the late response. Thanks for creating this issue. I made some changes on Basics -> Cargo. I think it's more cleaner now.
About comments; Those are sort of conventions and can be seen in https://doc.rust-lang.org/1.0.0/style/style/comments.html and https://github.com/rust-dev-tools/fmt-rfcs/blob/master/guide/guide.md partially.

And thanks again for reporting these :)