From f11b3c1a03379f5d2aae7fda58af85677f14d4d7 Mon Sep 17 00:00:00 2001
From: Robbert van der Helm <mail@robbertvanderhelm.nl>
Date: Mon, 4 Jul 2022 18:01:55 +0200
Subject: [PATCH] Fix typos in parameter value docstrings
---
src/param/boolean.rs | 2 +-
src/param/float.rs | 2 +-
src/param/integer.rs | 2 +-
3 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/src/param/boolean.rs b/src/param/boolean.rs
index 210f7ca4..4075e5f9 100644
--- a/src/param/boolean.rs
+++ b/src/param/boolean.rs
@@ -9,7 +9,7 @@ use super::{Param, ParamFlags, ParamMut};
/// A simple boolean parameter.
#[repr(C, align(4))]
pub struct BoolParam {
- /// The field's current value.
+ /// The field's current value, after monophonic modulation has been applied.
pub value: bool,
/// The field's current value normalized to the `[0, 1]` range.
normalized_value: f32,
diff --git a/src/param/float.rs b/src/param/float.rs
index 03e3be76..2bc85b63 100644
--- a/src/param/float.rs
+++ b/src/param/float.rs
@@ -21,7 +21,7 @@ use super::{Param, ParamFlags, ParamMut};
// a partially written to value here. We should probably reconsider this at some point though.
#[repr(C, align(4))]
pub struct FloatParam {
- /// The field's current plain, unnormalized value.
+ /// The field's current plain value, after monophonic modulation has been applied.
pub value: f32,
/// The field's current value normalized to the `[0, 1]` range.
normalized_value: f32,
diff --git a/src/param/integer.rs b/src/param/integer.rs
index 4bb2c13f..70413f4f 100644
--- a/src/param/integer.rs
+++ b/src/param/integer.rs
@@ -21,7 +21,7 @@ use super::{Param, ParamFlags, ParamMut};
// a partially written to value here. We should probably reconsider this at some point though.
#[repr(C, align(4))]
pub struct IntParam {
- /// The field's current plain, unnormalized value.
+ /// The field's current plain value, after monophonic modulation has been applied.
pub value: i32,
/// The field's current value normalized to the `[0, 1]` range.
normalized_value: f32,