@@ -95,7 +95,7 @@ impl Dir2 {
95
95
/// The directional axes.
96
96
pub const AXES : [ Self ; 2 ] = [ Self :: X , Self :: Y ] ;
97
97
98
- /// Create a direction from a finite, nonzero [`Vec2`].
98
+ /// Create a direction from a finite, nonzero [`Vec2`], normalizing it .
99
99
///
100
100
/// Returns [`Err(InvalidDirectionError)`](InvalidDirectionError) if the length
101
101
/// of the given vector is zero (or very close to zero), infinite, or `NaN`.
@@ -118,7 +118,8 @@ impl Dir2 {
118
118
Self ( value)
119
119
}
120
120
121
- /// Create a direction from a finite, nonzero [`Vec2`], also returning its original length.
121
+ /// Create a direction from a finite, nonzero [`Vec2`], normalizing it and
122
+ /// also returning its original length.
122
123
///
123
124
/// Returns [`Err(InvalidDirectionError)`](InvalidDirectionError) if the length
124
125
/// of the given vector is zero (or very close to zero), infinite, or `NaN`.
@@ -288,7 +289,7 @@ impl Dir3 {
288
289
/// The directional axes.
289
290
pub const AXES : [ Self ; 3 ] = [ Self :: X , Self :: Y , Self :: Z ] ;
290
291
291
- /// Create a direction from a finite, nonzero [`Vec3`].
292
+ /// Create a direction from a finite, nonzero [`Vec3`], normalizing it .
292
293
///
293
294
/// Returns [`Err(InvalidDirectionError)`](InvalidDirectionError) if the length
294
295
/// of the given vector is zero (or very close to zero), infinite, or `NaN`.
@@ -311,7 +312,8 @@ impl Dir3 {
311
312
Self ( value)
312
313
}
313
314
314
- /// Create a direction from a finite, nonzero [`Vec3`], also returning its original length.
315
+ /// Create a direction from a finite, nonzero [`Vec3`], normalizing it and
316
+ /// also returning its original length.
315
317
///
316
318
/// Returns [`Err(InvalidDirectionError)`](InvalidDirectionError) if the length
317
319
/// of the given vector is zero (or very close to zero), infinite, or `NaN`.
@@ -488,7 +490,7 @@ impl Dir3A {
488
490
/// The directional axes.
489
491
pub const AXES : [ Self ; 3 ] = [ Self :: X , Self :: Y , Self :: Z ] ;
490
492
491
- /// Create a direction from a finite, nonzero [`Vec3A`].
493
+ /// Create a direction from a finite, nonzero [`Vec3A`], normalizing it .
492
494
///
493
495
/// Returns [`Err(InvalidDirectionError)`](InvalidDirectionError) if the length
494
496
/// of the given vector is zero (or very close to zero), infinite, or `NaN`.
@@ -511,7 +513,8 @@ impl Dir3A {
511
513
Self ( value)
512
514
}
513
515
514
- /// Create a direction from a finite, nonzero [`Vec3A`], also returning its original length.
516
+ /// Create a direction from a finite, nonzero [`Vec3A`], normalizing it and
517
+ /// also returning its original length.
515
518
///
516
519
/// Returns [`Err(InvalidDirectionError)`](InvalidDirectionError) if the length
517
520
/// of the given vector is zero (or very close to zero), infinite, or `NaN`.
0 commit comments