Auto merge of #13392 - alex-semenyuk:doc_type_complexity, r=dswij

Clarify example for `type_complexity`

As mentioned #13387 it's not clear how to fix issue with complexity so add example for this

changelog: none
This commit is contained in:
bors 2024-09-22 11:51:07 +00:00
commit 2c5e600386

View File

@ -261,8 +261,59 @@
/// ### Example
/// ```no_run
/// # use std::rc::Rc;
/// struct Foo {
/// inner: Rc<Vec<Vec<Box<(u32, u32, u32, u32)>>>>,
/// struct PointMatrixContainer {
/// matrix: Rc<Vec<Vec<Box<(u32, u32, u32, u32)>>>>,
/// }
///
/// fn main() {
/// let point_matrix: Vec<Vec<Box<(u32, u32, u32, u32)>>> = vec![
/// vec![
/// Box::new((1, 2, 3, 4)),
/// Box::new((5, 6, 7, 8)),
/// ],
/// vec![
/// Box::new((9, 10, 11, 12)),
/// ],
/// ];
///
/// let shared_point_matrix: Rc<Vec<Vec<Box<(u32, u32, u32, u32)>>>> = Rc::new(point_matrix);
///
/// let container = PointMatrixContainer {
/// matrix: shared_point_matrix,
/// };
///
/// // ...
/// }
/// ```
/// Use instead:
/// ### Example
/// ```no_run
/// # use std::rc::Rc;
/// type PointMatrix = Vec<Vec<Box<(u32, u32, u32, u32)>>>;
/// type SharedPointMatrix = Rc<PointMatrix>;
///
/// struct PointMatrixContainer {
/// matrix: SharedPointMatrix,
/// }
///
/// fn main() {
/// let point_matrix: PointMatrix = vec![
/// vec![
/// Box::new((1, 2, 3, 4)),
/// Box::new((5, 6, 7, 8)),
/// ],
/// vec![
/// Box::new((9, 10, 11, 12)),
/// ],
/// ];
///
/// let shared_point_matrix: SharedPointMatrix = Rc::new(point_matrix);
///
/// let container = PointMatrixContainer {
/// matrix: shared_point_matrix,
/// };
///
/// // ...
/// }
/// ```
#[clippy::version = "pre 1.29.0"]