Merge pull request #607 from stm32-rs/typos

burrbull · web-flow · commit 277c7fa042f3 · 2023-04-19T09:33:08.000+03:00
fix typos
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -80,7 +80,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
  - Update `bxcan`, `rtic` and other dependencies [#519]
  - Bump `synopsys-usb-otg` to `0.3.1` [#535]
  - Renamed and updated rtic-button example (was rtic) [#551]
- - Rename adc_dma_rtic to rtic-adc-dma and move it ot defmt [#552]
+ - Rename adc_dma_rtic to rtic-adc-dma and move it to defmt [#552]
  - Rename spi_slave_dma_rtic to rtic-spi-slave-dma and unbroke it [#552]
  - Rename i2s-rtic-audio-in-out to rtic-i2s-audio-in-out [#552]
 
@@ -388,7 +388,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Features corresponding to peripherals [#311]
 - Improved documentation of rng and prelude [#303]
 - Added an example of integration with RTIC [#295]
-- Added internal pullup configuaration for the AlternateOD pin type [#298]
+- Added internal pullup configuration for the AlternateOD pin type [#298]
 - Added USART support for sending and receiving 9-bit words [#299]
 - Added support for I2S communication using SPI peripherals, and two examples [#265]
 - Added support for some LCD controllers using the Flexible Static Memory
@@ -399,7 +399,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Derive `Eq`, `PartialEq`, `Copy` and `Clone` for error types [#306]
 - Added open-drain pin mode support for PWM output [#313]
 - Added missing error flags for dma streams [#318]
-- Added PWM input capability to all compatable timers [#271]
+- Added PWM input capability to all compatible timers [#271]
 - Bidi mode support for SPI [#349]
 - Added `listen` and `unlisten` for RX- and TX-only USART [#357]
 - Added function for clearing the idle line interrupt in USART [#357]
@@ -545,7 +545,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Added `check_interrupt` method for GPIO pins
 - Basic support for DAC
 - Add initial DMA support
-- Allow specification of ADC reference voltage in ADC configuraton structure
+- Allow specification of ADC reference voltage in ADC configuration structure
 - Added support for hardware-based CRC32 functionality
 - Add `MonoTimer` and `Instant` structs for basic time measurement.
 - Added support for I2S and SAI clocks
@@ -756,11 +756,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Changed
 
-- Made the `rt` feature of stm32f4 optionnal.
+- Made the `rt` feature of stm32f4 optional.
 
 ### Fixed
 
-- Avoid overwritting the cache bits in `flash.acr`.
+- Avoid overwriting the cache bits in `flash.acr`.
 
 ## [v0.2.3] - 2018-11-04
 
diff --git a/examples/blinky-timer-irq.rs b/examples/blinky-timer-irq.rs
@@ -37,7 +37,7 @@ static G_LED: Mutex<RefCell<Option<LedPin>>> = Mutex::new(RefCell::new(None));
 // Make timer interrupt registers globally available
 static G_TIM: Mutex<RefCell<Option<CounterUs<TIM2>>>> = Mutex::new(RefCell::new(None));
 
-// Define an interupt handler, i.e. function to call when interrupt occurs.
+// Define an interrupt handler, i.e. function to call when interrupt occurs.
 // This specific interrupt will "trip" when the timer TIM2 times out
 #[interrupt]
 fn TIM2() {
diff --git a/examples/can-send.rs b/examples/can-send.rs
@@ -63,7 +63,7 @@ fn main() -> ! {
         can2
     };
 
-    // Drop filters to leave filter configuraiton mode.
+    // Drop filters to leave filter configuration mode.
     drop(filters);
 
     // Select the interface.
diff --git a/examples/display-touch.rs b/examples/display-touch.rs
@@ -154,7 +154,7 @@ fn main() -> ! {
     // The touch coordinates and shapes are adjusted accordingly.
     rprintln!("The orientation set is {}", disp.orientation() as u8);
 
-    // Intializing the i2c bus for touchscreen
+    // Initializing the i2c bus for touchscreen
     rprintln!("Connecting to I2c");
 
     // Declare the pins for i2c address bus on each board.
diff --git a/examples/rtic-i2s-audio-in-out.rs b/examples/rtic-i2s-audio-in-out.rs
@@ -341,7 +341,7 @@ mod app {
                 // in case of udr this resynchronize tracked and actual channel
                 _ => {
                     *frame_state = LeftMsb;
-                    data = 0; //garbage data to avoid additional underrrun
+                    data = 0; //garbage data to avoid additional underrun
                 }
             }
             i2s3_driver.write_data_register(data);
diff --git a/examples/ws2812-spi.rs b/examples/ws2812-spi.rs
@@ -33,7 +33,7 @@ fn main() -> ! {
     const NUM_LEDS: usize = 8;
     let mut data = [RGB8::default(); NUM_LEDS];
 
-    // Wait before start write for syncronization
+    // Wait before start write for synchronization
     delay.delay(200.micros());
 
     loop {
diff --git a/src/adc.rs b/src/adc.rs
@@ -258,7 +258,7 @@ pub mod config {
         Tim_5_cc_2,
         /// TIM5 compare channel 3
         Tim_5_cc_3,
-        /// External interupt line 11
+        /// External interrupt line 11
         Exti_11,
     }
     impl From<ExternalTrigger> for u8 {
diff --git a/src/gpio.rs b/src/gpio.rs
@@ -136,7 +136,7 @@ pub type Debugger = Alternate<0, PushPull>;
 
 pub(crate) mod marker {
     /// Marker trait that show if `ExtiPin` can be implemented
-    pub trait Interruptable {}
+    pub trait Interruptible {}
     /// Marker trait for readable pin modes
     pub trait Readable {}
     /// Marker trait for slew rate configurable pin modes
@@ -149,11 +149,11 @@ pub(crate) mod marker {
     pub trait IntoAf<const A: u8> {}
 }
 
-impl<MODE> marker::Interruptable for Output<MODE> {}
-impl marker::Interruptable for Input {}
+impl<MODE> marker::Interruptible for Output<MODE> {}
+impl marker::Interruptible for Input {}
 impl marker::Readable for Input {}
 impl marker::Readable for Output<OpenDrain> {}
-impl<const A: u8, Otype> marker::Interruptable for Alternate<A, Otype> {}
+impl<const A: u8, Otype> marker::Interruptible for Alternate<A, Otype> {}
 impl<const A: u8, Otype> marker::Readable for Alternate<A, Otype> {}
 impl marker::Active for Input {}
 impl<Otype> marker::OutputSpeed for Output<Otype> {}
diff --git a/src/gpio/dynamic.rs b/src/gpio/dynamic.rs
@@ -50,7 +50,7 @@ impl Dynamic {
     }
 }
 
-// For convertion simplify
+// For conversion simplify
 struct Unknown;
 
 impl crate::Sealed for Unknown {}
diff --git a/src/gpio/exti.rs b/src/gpio/exti.rs
@@ -47,7 +47,7 @@ pub trait ExtiPin {
 impl<PIN> ExtiPin for PIN
 where
     PIN: PinExt,
-    PIN::Mode: marker::Interruptable,
+    PIN::Mode: marker::Interruptible,
 {
     #[inline(always)]
     fn make_interrupt_source(&mut self, syscfg: &mut SysCfg) {
diff --git a/src/i2c.rs b/src/i2c.rs
@@ -439,7 +439,7 @@ impl<I2C: Instance> I2c<I2C> {
         self.read_wo_prepare(buffer)
     }
 
-    /// Reads like normal but does'n genereate start and don't send address
+    /// Reads like normal but does'n generate start and don't send address
     fn read_wo_prepare(&mut self, buffer: &mut [u8]) -> Result<(), Error> {
         if let Some((last, buffer)) = buffer.split_last_mut() {
             // Read all bytes but not last
@@ -468,7 +468,7 @@ impl<I2C: Instance> I2c<I2C> {
         self.write_wo_prepare(bytes)
     }
 
-    /// Writes like normal but does'n genereate start and don't send address
+    /// Writes like normal but does'n generate start and don't send address
     fn write_wo_prepare(&mut self, bytes: &[u8]) -> Result<(), Error> {
         self.write_bytes(bytes.iter().cloned())?;
 
diff --git a/src/i2c/dma.rs b/src/i2c/dma.rs
@@ -489,13 +489,13 @@ where
         // Clear condition by reading SR2. This will clear ADDR flag
         self.hal_i2c.i2c.sr2.read();
 
-        // Enable error interrups
+        // Enable error interrupts
         self.enable_error_interrupt_generation();
 
         Ok(())
     }
 
-    /// Generates start and send addres for read commands
+    /// Generates start and send address for read commands
     fn prepare_read(&mut self, addr: u8, buf_len: usize) -> Result<(), super::Error> {
         // Start
         self.send_start(true)?;
@@ -511,7 +511,7 @@ where
         // Clear condition by reading SR2. This will clear ADDR flag
         self.hal_i2c.i2c.sr2.read();
 
-        // Enable error interrups
+        // Enable error interrupts
         self.enable_error_interrupt_generation();
 
         Ok(())
diff --git a/src/rng.rs b/src/rng.rs
@@ -19,7 +19,7 @@
 //! let rand_val = rand_source.next_u32();
 //! ```
 //!
-//! A full exaple can be found [in the examples folder on github](https://github.com/stm32-rs/stm32f4xx-hal/blob/master/examples/rng-display.rs)
+//! A full example can be found [in the examples folder on github](https://github.com/stm32-rs/stm32f4xx-hal/blob/master/examples/rng-display.rs)
 use core::cmp;
 use core::mem;
 
diff --git a/src/serial.rs b/src/serial.rs
@@ -60,7 +60,7 @@ pub mod config {
 
     /// Parity generation and checking. If odd or even parity is selected, the
     /// underlying USART will be configured to send/receive the parity bit in
-    /// addtion to the data bits.
+    /// addition to the data bits.
     #[cfg_attr(feature = "defmt", derive(defmt::Format))]
     #[derive(Debug, Clone, Copy, PartialEq, Eq)]
     pub enum Parity {
diff --git a/src/timer.rs b/src/timer.rs
@@ -673,12 +673,12 @@ impl<TIM: Instance, const FREQ: u32> FTimer<TIM, FREQ> {
         self.tim.set_prescaler(u16::try_from(psc - 1).unwrap());
     }
 
-    /// Creates `Counter` that imlements [embedded_hal::timer::CountDown]
+    /// Creates `Counter` that implements [embedded_hal::timer::CountDown]
     pub fn counter(self) -> Counter<TIM, FREQ> {
         Counter(self)
     }
 
-    /// Creates `Delay` that imlements [embedded_hal::blocking::delay] traits
+    /// Creates `Delay` that implements [embedded_hal::blocking::delay] traits
     pub fn delay(self) -> Delay<TIM, FREQ> {
         Delay(self)
     }
diff --git a/src/timer/counter.rs b/src/timer/counter.rs
@@ -68,7 +68,7 @@ impl<TIM: Instance> CounterHz<TIM> {
     }
 }
 
-/// Periodic non-blocking timer that imlements [embedded_hal::timer::CountDown]
+/// Periodic non-blocking timer that implements [embedded_hal::timer::CountDown]
 pub struct Counter<TIM, const FREQ: u32>(pub(super) FTimer<TIM, FREQ>);
 
 impl<T, const FREQ: u32> Deref for Counter<T, FREQ> {
diff --git a/src/timer/delay.rs b/src/timer/delay.rs
@@ -58,7 +58,7 @@ impl SysDelay {
     }
 }
 
-/// Periodic non-blocking timer that imlements [embedded_hal::blocking::delay] traits.
+/// Periodic non-blocking timer that implements [embedded_hal::blocking::delay] traits.
 ///
 /// ### Example: Millisecond precision
 ///
diff --git a/src/timer/pwm.rs b/src/timer/pwm.rs
@@ -1,6 +1,6 @@
 //! Provides basic Pulse-width modulation (PWM) capabilities
 //!
-//! There are 2 main stuctures [`Pwm`] and [`PwmHz`]. Both structures implement [`embedded_hal::Pwm`] and have some additional API.
+//! There are 2 main structures [`Pwm`] and [`PwmHz`]. Both structures implement [`embedded_hal::Pwm`] and have some additional API.
 //!
 //! First one is based on [`FTimer`] with fixed prescaler
 //! and easy to use with [`fugit::TimerDurationU32`] for setting pulse width and period without advanced calculations.

Original file line number	Diff line number	Diff line change
`@@ -341,7 +341,7 @@ mod app {`
`341`	`341`	`// in case of udr this resynchronize tracked and actual channel`
`342`	`342`	`_ => {`
`343`	`343`	`*frame_state = LeftMsb;`
`344`		`- data = 0; //garbage data to avoid additional underrrun`
	`344`	`+ data = 0; //garbage data to avoid additional underrun`
`345`	`345`	`}`
`346`	`346`	`}`
`347`	`347`	`i2s3_driver.write_data_register(data);`
Original file line number	Diff line number	Diff line change
`@@ -258,7 +258,7 @@ pub mod config {`
`258`	`258`	`Tim_5_cc_2,`
`259`	`259`	`/// TIM5 compare channel 3`
`260`	`260`	`Tim_5_cc_3,`
`261`		`- /// External interupt line 11`
	`261`	`+ /// External interrupt line 11`
`262`	`262`	`Exti_11,`
`263`	`263`	`}`
`264`	`264`	`impl From<ExternalTrigger> for u8 {`
Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ impl Dynamic {`
`50`	`50`	`}`
`51`	`51`	`}`
`52`	`52`
`53`		`-// For convertion simplify`
	`53`	`+// For conversion simplify`
`54`	`54`	`struct Unknown;`
`55`	`55`
`56`	`56`	`impl crate::Sealed for Unknown {}`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ pub trait ExtiPin {`
`47`	`47`	`impl<PIN> ExtiPin for PIN`
`48`	`48`	`where`
`49`	`49`	`PIN: PinExt,`
`50`		`- PIN::Mode: marker::Interruptable,`
	`50`	`+ PIN::Mode: marker::Interruptible,`
`51`	`51`	`{`
`52`	`52`	`#[inline(always)]`
`53`	`53`	`fn make_interrupt_source(&mut self, syscfg: &mut SysCfg) {`