mirror of
https://github.com/rust-lang/rust.git
synced 2026-05-29 12:36:35 +03:00
Rewrite the first sentence in slice::sort
For every method, the first sentence should consisely explain what it does, not how. This sentence usually starts with a verb. It's really weird for `sort` to be explained in terms of another function, namely `sort_by`. There's no need for that because it's obvious how `sort` sorts elements: there is `T: Ord`. If `sort_by_key` does not have to explicitly state how it's implemented, then `sort` doesn't either.
This commit is contained in:
@@ -509,7 +509,7 @@ pub fn swap(&mut self, a: usize, b: usize) {
|
||||
core_slice::SliceExt::swap(self, a, b)
|
||||
}
|
||||
|
||||
/// Reverse the order of elements in a slice, in place.
|
||||
/// Reverses the order of elements in a slice, in place.
|
||||
///
|
||||
/// # Example
|
||||
///
|
||||
@@ -1062,7 +1062,7 @@ pub fn binary_search_by_key<'a, B, F>(&'a self, b: &B, f: F) -> Result<usize, us
|
||||
core_slice::SliceExt::binary_search_by_key(self, b, f)
|
||||
}
|
||||
|
||||
/// This is equivalent to `self.sort_by(|a, b| a.cmp(b))`.
|
||||
/// Sorts the slice.
|
||||
///
|
||||
/// This sort is stable (i.e. does not reorder equal elements) and `O(n log n)` worst-case.
|
||||
///
|
||||
|
||||
Reference in New Issue
Block a user