Merge pull request #4588 from sanxiyn/doc-mut-arg

doc: Document mutable function arguments
This commit is contained in:
Tim Chevalier 2013-01-23 10:35:56 -08:00
commit bca39a7a03

View file

@ -3018,6 +3018,11 @@ Local variables are immutable unless declared with `let mut`. The
declaration (so `let mut x, y` declares two mutable variables, `x` and
`y`).
Function parameters are immutable unless declared with `mut`. The
`mut` keyword applies only to the following parameter (so `|mut x, y|`
and `fn f(mut x: ~int, y: ~int)` declare one mutable variable `x` and
one immutable variable `y`).
Local variables are not initialized when allocated; the entire frame worth of
local variables are allocated at once, on frame-entry, in an uninitialized
state. Subsequent statements within a function may or may not initialize the