Skip to content

Commit

Permalink
Add warning to documentation to ensure that people won't mix a match …
Browse files Browse the repository at this point in the history
…update functions
  • Loading branch information
Jan Herlyn committed Mar 10, 2024
1 parent 553cab7 commit 7af1ac4
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions src/fusion_impl.rs
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,10 @@ impl Fusion {
/// Updates the AHRS algorithm based on gyroscope data in degrees/s and acceleration data in g force.
///
/// The time is provided as a duration in seconds since the last measurement.
/// Note that this won't increase the internal timestamp and using the timestamp version of update functions will produce incorrect results.
///
/// # Examples
/// ```
/// ```no_run
/// use imu_fusion::{Fusion, FusionVector, FusionAhrsSettings};
/// use std::time::{Duration, Instant};
///
Expand Down Expand Up @@ -129,12 +130,13 @@ impl Fusion {
/// Updates the AHRS algorithm based on gyroscope data in degrees/s, acceleration data in g force and a heading in degrees.
///
/// The time is provided using a duration in seconds since the last measurement.
/// Note that this won't increase the internal timestamp and using the timestamp version of update functions will produce incorrect results.
///
/// # Examples
/// ```no_run
/// use imu_fusion::{Fusion, FusionVector, FusionAhrsSettings};
/// use std::time::{Duration, Instant};
///
///
/// const SAMPLE_RATE_HZ: u32 = 100;
///
/// let ahrs_settings = FusionAhrsSettings::new();
Expand Down Expand Up @@ -206,7 +208,7 @@ impl Fusion {
/// Updates the AHRS algorithm based on gyroscope data in degrees/s, acceleration data in g force and magnetic measurements in degrees.
///
/// The time is provided using a duration in seconds since the last measurement.
///
/// Note that this won't increase the internal timestamp and using the timestamp version of update functions will produce incorrect results.
/// # Examples
/// ```no_run
/// use imu_fusion::{Fusion, FusionAhrsSettings, FusionVector};
Expand Down

0 comments on commit 7af1ac4

Please sign in to comment.