Skip to content
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.

Sign up for GitHub

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

Doc backport #24814

Merged
merged 19 commits into from
Apr 25, 2015
Merged

Doc backport #24814

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
eb00266
Backport of https://github.com/rust-lang/rust/pull/24783
steveklabnik Apr 25, 2015
1d7bd95
Remove doc-comment default::Default imports
frewsxcv Apr 22, 2015
3185970
Add examples by @pnkfelix to fmt precision
steveklabnik Apr 21, 2015
4ceda40
Whoops, please tidy
steveklabnik Apr 24, 2015
b403560
Update reference to old_io in fmt docs
mbrubeck Apr 21, 2015
051fb37
Clean up Box documentation.
steveklabnik Apr 20, 2015
75051c6
remove bad example from PartialEq docs
steveklabnik Apr 20, 2015
abbd9dc
Make iterator struct docs more consistent.
steveklabnik Apr 20, 2015
6ab15dc
Simplify alloc::arc::Arc example in doc-comment
frewsxcv Apr 20, 2015
5b98619
Fix typos in code comments
frewsxcv Apr 19, 2015
44c5aa5
Improve doc for `Result::unwrap()`
bombless Apr 19, 2015
6a31baa
Remove the 30 minute intro
steveklabnik Apr 18, 2015
88f1b2d
Update Windows caveats
tamird Apr 18, 2015
f796438
Utilize if..let for get_mut doc-comment examples
frewsxcv Apr 18, 2015
9e25983
Indicate keywords are code-like in Fuse::reset_fuse doc comment
frewsxcv Apr 18, 2015
007060b
doc: improve/fix 'let' FAQ
tshepang Apr 18, 2015
f19a12d
Fix broken links in the docs
fhartwig Apr 16, 2015
01db977
Indicate None is code-like in doc comments
frewsxcv Apr 16, 2015
b43138b
Fixed typo in hash_map::Entry documentation
aramvisser Apr 16, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions src/doc/complement-design-faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Types which are [`Sync`][sync] are thread-safe when multiple shared
references to them are used concurrently. Types which are not `Sync` are not
thread-safe, and thus when used in a global require unsafe code to use.

[sync]: core/kinds/trait.Sync.html
[sync]: core/marker/trait.Sync.html

### If mutable static items that implement `Sync` are safe, why is taking &mut SHARABLE unsafe?

Expand Down Expand Up @@ -139,7 +139,7 @@ and explicitly calling the `clone` method. Making user-defined copy operators
explicit surfaces the underlying complexity, forcing the developer to opt-in
to potentially expensive operations.

[copy]: core/kinds/trait.Copy.html
[copy]: core/marker/trait.Copy.html
[clone]: core/clone/trait.Clone.html

## No move constructors
Expand All @@ -165,12 +165,13 @@ particularly easy to read.

## Why is `let` used to introduce variables?

We don't use the term "variable", instead, we use "variable bindings". The
simplest way for binding is the `let` syntax, other ways including `if let`,
`while let` and `match`. Bindings also exist in function arguments positions.
Instead of the term "variable", we use "variable bindings". The
simplest way for creating a binding is by using the `let` syntax.
Other ways include `if let`, `while let`, and `match`. Bindings also
exist in function argument positions.

Bindings always happen in pattern matching positions, and it's also Rust's way
to declare mutability. One can also redeclare mutability of a binding in
to declare mutability. One can also re-declare mutability of a binding in
pattern matching. This is useful to avoid unnecessary `mut` annotations. An
interesting historical note is that Rust comes, syntactically, most closely
from ML, which also uses `let` to introduce bindings.
Expand Down
5 changes: 1 addition & 4 deletions src/doc/complement-lang-faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,7 @@ Let the fact that this is an easily countable number be a warning.

## Does it run on Windows?

Yes. All development happens in lockstep on all 3 target platforms (using MinGW, not Cygwin). Note that the Windows implementation currently has some limitations; in particular, the 64-bit build is [not fully supported yet][win64], and all executables created by rustc [depend on libgcc DLL at runtime][libgcc].

[win64]: https://github.com/rust-lang/rust/issues/1237
[libgcc]: https://github.com/rust-lang/rust/issues/11782
Yes. All development happens in lockstep on all 3 target platforms (using MinGW, not Cygwin).

## Is it OO? How do I do this thing I normally do in an OO language?

Expand Down
Loading