From c379d96c679fc7a60f3ba1bce1def53f5c64657e Mon Sep 17 00:00:00 2001 From: Seo Sanghyeon Date: Wed, 23 Jan 2013 17:20:36 +0900 Subject: [PATCH] doc: Document mutable function arguments --- doc/rust.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/rust.md b/doc/rust.md index 711a2bf28f0..697c395bc82 100644 --- a/doc/rust.md +++ b/doc/rust.md @@ -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