Document how to configure sample rate period

damb · Sep 5, 2023 · 1432358 · 1432358
1 parent 73100a7
commit 1432358
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/pack.rs b/src/pack.rs
@@ -136,6 +136,11 @@ impl PackInfo {
     /// identifier](https://docs.fdsn.org/projects/source-identifiers/) with configured sample
     /// rate.
     ///
+    /// Note that by [libmseed](https://github.com/EarthScope/libmseed) convention a negative
+    /// `sample_rate` value is considered as a *sample rate period* (i.e. in units of seconds (`s`)),
+    /// while a positive sample rate value is considered as a *sample rate frequency* (i.e. in units
+    /// of Hertz (`Hz`)).
+    ///
     /// See also [`factor_multiplier_to_sample_rate`](util::factor_multiplier_to_sample_rate()).
     pub fn with_sample_rate<T>(sid: T, sample_rate: c_double) -> MSResult<Self>
     where