alex/agb
1
0
Fork 0
mirror of https://github.com/italicsjenga/agb.git synced 2024-12-23 16:21:33 +11:00
Code Issues Packages Projects Releases Wiki Activity

fix spelling errors in agb-fixnum

Browse source
This commit is contained in:
Gwilym Kuiper 2022-11-17 21:17:52 +00:00
parent deb907b9eb
commit 648a544ea8
2 changed files with 7 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.vscode/settings.json vendored
View file

@ -30,6 +30,7 @@
"EEPROM", "EEPROM",
"ewram", "ewram",
"fixnum", "fixnum",
"fixnums",
"fontdue", "fontdue",
"fract", "fract",
"FRAM", "FRAM",
@ -54,6 +55,7 @@
"mgba", "mgba",
"normalise", "normalise",
"normalised", "normalised",
"Normalises",
"nostack", "nostack",
"Optimisation", "Optimisation",
"optimise", "optimise",

10
agb-fixnum/src/lib.rs
View file

@ -424,7 +424,7 @@ impl<I: FixedWidthUnsignedInteger, const N: usize> Num<I, N> {
impl<const N: usize> Num<i32, N> { impl<const N: usize> Num<i32, N> {
#[must_use] #[must_use]
/// Returns the square root of a number, it is calcuated a digit at a time. /// Returns the square root of a number, it is calculated a digit at a time.
/// ``` /// ```
/// # use agb_fixnum::*; /// # use agb_fixnum::*;
/// let n: Num<i32, 8> = num!(16.); /// let n: Num<i32, 8> = num!(16.);
@ -530,7 +530,7 @@ impl<I: FixedWidthUnsignedInteger, const N: usize> Display for Num<I, N> {
let mut fractional = self.0 & mask; let mut fractional = self.0 & mask;
// Negative fix nums are awkward to print if they have non zero fractional part. // Negative fixnums are awkward to print if they have non zero fractional part.
// This is because you can think of them as `number + non negative fraction`. // This is because you can think of them as `number + non negative fraction`.
// //
// But if you think of a negative number, you'd like it to be `negative number - non negative fraction` // But if you think of a negative number, you'd like it to be `negative number - non negative fraction`
@ -569,7 +569,7 @@ impl<I: FixedWidthUnsignedInteger, const N: usize> Debug for Num<I, N> {
} }
} }
/// A vector of two points: (x, y) represened by integers or fixed point numbers /// A vector of two points: (x, y) represented by integers or fixed point numbers
#[derive(Clone, Copy, PartialEq, Eq, Debug, Default)] #[derive(Clone, Copy, PartialEq, Eq, Debug, Default)]
pub struct Vector2D<T: Number> { pub struct Vector2D<T: Number> {
/// The x coordinate /// The x coordinate
@ -675,7 +675,7 @@ impl<I: FixedWidthUnsignedInteger, const N: usize> Vector2D<Num<I, N>> {
} }
#[must_use] #[must_use]
/// Floors the x and y coordnate, see [Num::floor] /// Floors the x and y coordinate, see [Num::floor]
/// ``` /// ```
/// # use agb_fixnum::*; /// # use agb_fixnum::*;
/// let v1: Vector2D<Num<i32, 8>> = Vector2D::new(num!(1.56), num!(-2.2)); /// let v1: Vector2D<Num<i32, 8>> = Vector2D::new(num!(1.56), num!(-2.2));
@ -984,7 +984,7 @@ impl<T: Number> Vector2D<T> {
Vector2D { x, y } Vector2D { x, y }
} }
/// Returns the tuple of the coorinates /// Returns the tuple of the coordinates
/// ``` /// ```
/// # use agb_fixnum::*; /// # use agb_fixnum::*;
/// let v = Vector2D::new(1, 2); /// let v = Vector2D::new(1, 2);