-
Notifications
You must be signed in to change notification settings - Fork 12.7k
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.
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
improve array_from_fn documenation #104839
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -23,7 +23,8 @@ mod iter; | |||||
#[stable(feature = "array_value_iter", since = "1.51.0")] | ||||||
pub use iter::IntoIter; | ||||||
|
||||||
/// Creates an array `[T; N]` where each array element `T` is returned by the `cb` call. | ||||||
/// Creates an array of type [T; N], where each element `T` is the returned value from `cb` | ||||||
/// using that element's index. | ||||||
/// | ||||||
/// # Arguments | ||||||
/// | ||||||
|
@@ -36,8 +37,18 @@ pub use iter::IntoIter; | |||||
/// // elements to produce is the length of array down there: only arrays of | ||||||
/// // equal lengths can be compared, so the const generic parameter `N` is | ||||||
/// // inferred to be 5, thus creating array of 5 elements. | ||||||
/// let array = core::array::from_fn(|i| i); | ||||||
/// | ||||||
/// let array: [_; 5] = core::array::from_fn(|i| i); | ||||||
/// // indexes are: 0 1 2 3 4 | ||||||
/// assert_eq!(array, [0, 1, 2, 3, 4]); | ||||||
/// | ||||||
/// let array2: [_; 8] = core::array::from_fn(|i| i * 2); | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Then it would be good to mention the type annotation on this on to contrast with the first one. |
||||||
/// // indexes are: 0 1 2 3 4 5 6 7 | ||||||
/// assert_eq!(array2, [0, 2, 4, 6, 8, 10, 12, 14]); | ||||||
/// | ||||||
/// let bool_arr: [bool; 5] = core::array::from_fn(|i| i % 2 == 0); | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. And for completeness, maybe show turbofishing for this one?
Suggested change
|
||||||
/// // indexes are: 0 1 2 3 4 | ||||||
/// assert_eq!(bool_arr, [true, false, true, false, true]); | ||||||
/// ``` | ||||||
#[inline] | ||||||
#[stable(feature = "array_from_fn", since = "1.63.0")] | ||||||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Given the big comment about type inference above this one, I think this example should stay of inferred width