diff options
| author | bors <bors@rust-lang.org> | 2014-04-18 04:11:19 -0700 |
|---|---|---|
| committer | bors <bors@rust-lang.org> | 2014-04-18 04:11:19 -0700 |
| commit | ce2bab68d69ee04e17c0165dbdb7b583d5a7c991 (patch) | |
| tree | addec7ff5238ab59b8510d2fe6fb679a8dd07a79 /src/doc | |
| parent | d35804ea5e69c9a3a8957626533a856f976fe4e3 (diff) | |
| parent | 58ae1e7c625491e9eceebdc9120ff009361106fa (diff) | |
| download | rust-ce2bab68d69ee04e17c0165dbdb7b583d5a7c991.tar.gz rust-ce2bab68d69ee04e17c0165dbdb7b583d5a7c991.zip | |
auto merge of #13585 : brandonw/rust/patch-1, r=cmr
The original text stated that one should only return a unique or managed pointer if you were given one in the first place. This makes it sound as if the function *should* return a unique pointer if it were given a unique pointer. The rest of the section goes on to describe why this is bad, and the example of bad code does exactly what the rule just said to do. I reworded the original rule into a reference to the more concise rule mentioned at the bottom of the section, which helps add emphasis (a la 'it bears repeating').
Diffstat (limited to 'src/doc')
| -rw-r--r-- | src/doc/guide-pointers.md | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/src/doc/guide-pointers.md b/src/doc/guide-pointers.md index 5c6c562b72d..9780a12a402 100644 --- a/src/doc/guide-pointers.md +++ b/src/doc/guide-pointers.md @@ -430,8 +430,9 @@ great detail, so if you want the full details, check that out. # Returning Pointers We've talked a lot about functions that accept various kinds of pointers, but -what about returning them? Here's the rule of thumb: only return a unique or -managed pointer if you were given one in the first place. +what about returning them? In general, it is better to let the caller decide +how to use a function's output, instead of assuming a certain type of pointer +is best. What does that mean? Don't do this: |