-
Notifications
You must be signed in to change notification settings - Fork 13.4k
Guide could use some copy-editing and general TLC #19335
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Comments
The guide is inconsistent with its use of certain conventions. These don't really have a correct form, but a single style should be enforced.
|
If you find any obvious errors, or think you can write a section in a better way, please don't hesitate to submit a PR with a fix. You don't need to compile a compiler or download the source to edit the guide. You can do it all in github's ui, for the most part. |
@apasel422 thanks for being specific. And for your earlier pull request. As for these...
|
Made things a tad less informal, broke up Installation section with some subheaders, and adjusted some wording. Work on rust-lang#19335.
Further copy-editing of the Rust Guide, including some slight adjustments in Installing Rust section, paragraph reflows up to Hello, Cargo section and general copy clean up and clarification. Work on rust-lang#19335
More work on rust-lang#19335 Changes up to but not including the Strings section. Apart from rewording some unclear, oddly-phrased, or slightly incorrect passages, the most significant changes are the removal of short sections of code or passages which are more appropriate for rookies than programmers who are merely new to systems programming with Rust.
Strings and Arrays, Vectors, and Slices sections received some editing love. rust-lang#19335
Made things a tad less informal, broke up Installation section with some subheaders, corrected "Installing Rust", adjusted some wording, punctuation nits, markup syntax corrections, etc. Work on rust-lang#19335.
There are a number of small typos in the guide, and some of the prose could be tightened up or clarified.
In general the tone of the guide comes across as trying too hard to be chatty. Keeping things casual is probably a good idea for Rust's introductory document, but we can probably remove most (all?) of the chatty prose without becoming stodgy or boring.
The text was updated successfully, but these errors were encountered: