Skip to content

Commit d75f4fb

Browse files
committed
Update some doc strings
1 parent acd0cfa commit d75f4fb

2 files changed

Lines changed: 3 additions & 3 deletions

File tree

splashsurf_lib/src/aabb.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ where
158158
self.translate(&(self.centroid() * R::one().neg()));
159159
}
160160

161-
/// Applies a uniform, local scaling to the AABB (as if it was centered at the origin)
161+
/// Multiplies a uniform, local scaling to the AABB (i.e. multiplying its extents as if it was centered at the origin)
162162
pub fn scale_uniformly(&mut self, scaling: R) {
163163
let center = self.centroid();
164164
self.translate(&(&center * R::one().neg()));
@@ -183,7 +183,7 @@ where
183183
}
184184
}
185185

186-
/// Grows this AABB uniformly in all directions by the given scalar margin
186+
/// Grows this AABB uniformly in all directions by the given scalar margin (i.e. adding the margin to min/max extents)
187187
pub fn grow_uniformly(&mut self, margin: R) {
188188
self.min = &self.min - &VectorN::repeat(margin);
189189
self.max = &self.max + &VectorN::repeat(margin);

splashsurf_lib/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ macro_rules! map_option {
122122
}
123123

124124
impl<R: Real> Parameters<R> {
125-
/// Tries to convert the parameters from one real type to another real type, returns None if conversion fails
125+
/// Tries to convert the parameters from one [Real] type to another [Real] type, returns None if conversion fails
126126
pub fn try_convert<T: Real>(&self) -> Option<Parameters<T>> {
127127
Some(Parameters {
128128
particle_radius: self.particle_radius.try_convert()?,

0 commit comments

Comments
 (0)